Oops! This page doesn't exist. Try going back to our home page.
-You can learn how to make a 404 page like this in Custom 404 Pages.
{{ end }} diff --git a/public/404.html b/public/404.html index dd4feb3..29065b5 100644 --- a/public/404.html +++ b/public/404.html @@ -75,7 +75,6 @@Oops! This page doesn't exist. Try going back to our home page.
-You can learn how to make a 404 page like this in Custom 404 Pages.
diff --git a/public/about/index.html b/public/about/index.html index 8fe7e96..4272879 100644 --- a/public/about/index.html +++ b/public/about/index.html @@ -4,7 +4,6 @@ - diff --git a/public/blog/2023/05/30/helping-with-federated-core-documentation/index.html b/public/blog/2023/05/30/helping-with-federated-core-documentation/index.html index 95c9d37..c44a150 100644 --- a/public/blog/2023/05/30/helping-with-federated-core-documentation/index.html +++ b/public/blog/2023/05/30/helping-with-federated-core-documentation/index.html @@ -117,8 +117,7 @@ Edit this page Create child page Create documentation issue - Print entire section - + @@ -174,9 +175,11 @@Welcome to Federated Core!
+What does your user need to know to try your project?
-A short lead description about this content page. It can be bold or italic and can be split over multiple paragraphs.
diff --git a/public/categories/examples/index.xml b/public/categories/examples/index.xml index 4932d42..d00a6a3 100644 --- a/public/categories/examples/index.xml +++ b/public/categories/examples/index.xml @@ -15,45 +15,7 @@Welcome to Federated Core!
+This is a placeholder page. Replace it with your own content.
+This documentation is for users and administrators, not those wanting to install.
This is the section landing page.
+A short lead description about this section page. Text here can also be bold or italic and can even be split over multiple paragraphs.
+Baserow is a no-code database application allowing you to quickly create customized applications for your team and company.
diff --git a/public/docs/core_applications/index.xml b/public/docs/core_applications/index.xml index 470af0b..391da31 100644 --- a/public/docs/core_applications/index.xml +++ b/public/docs/core_applications/index.xml @@ -26,11 +26,11 @@ <div class="pageinfo pageinfo-primary"> -<p>This is a placeholder page. Replace it with your own content.</p> +<p>This documentation is for users and administrators, not those wanting to install.</p> </div> -<p>This is the section landing page.</p> +<h3 id="configuring-users-for-baserow">Configuring Users for Baserow</h3> diff --git a/public/docs/core_applications/jitsi/index.html b/public/docs/core_applications/jitsi/index.html index bc5a1f6..aa20b92 100644 --- a/public/docs/core_applications/jitsi/index.html +++ b/public/docs/core_applications/jitsi/index.html @@ -4,7 +4,6 @@ - @@ -95,7 +94,7 @@ Getting StartedThis is a placeholder page. Replace it with your own content.
+This documentation is for users and administrators, not those wanting to install.
Text can be bold, italic, or strikethrough. Links should be blue with no underlines (unless hovered over).
There should be whitespace between paragraphs. Vape migas chillwave sriracha poutine try-hard distillery. Tattooed shabby chic small batch, pabst art party heirloom letterpress air plant pop-up. Sustainable chia skateboard art party banjo cardigan normcore affogato vexillologist quinoa meggings man bun master cleanse shoreditch readymade. Yuccie prism four dollar toast tbh cardigan iPhone, tumblr listicle live-edge VHS. Pug lyft normcore hot chicken biodiesel, actually keffiyeh thundercats photo booth pour-over twee fam food truck microdosing banh mi. Vice activated charcoal raclette unicorn live-edge post-ironic. Heirloom vexillologist coloring book, beard deep v letterpress echo park humblebrag tilde.
-90’s four loko seitan photo booth gochujang freegan tumeric listicle fam ugh humblebrag. Bespoke leggings gastropub, biodiesel brunch pug fashion axe meh swag art party neutra deep v chia. Enamel pin fanny pack knausgaard tofu, artisan cronut hammock meditation occupy master cleanse chartreuse lumbersexual. Kombucha kogi viral truffaut synth distillery single-origin coffee ugh slow-carb marfa selfies. Pitchfork schlitz semiotics fanny pack, ugh artisan vegan vaporware hexagon. Polaroid fixie post-ironic venmo wolf ramps kale chips.
+The following information is sent to each new Federated Core customer.
--There should be no margin above this first sentence.
-Blockquotes should be a lighter gray with a border along the left side in the secondary color.
-There should be no margin below this final sentence.
+Dear Federated Customer,
+Please read this note in its entirety since it has some important information for you to get the best use out of your Federated Core. If you ever get stuck for whatever reason, please reach out to us for support:
This is a normal paragraph following a header. Knausgaard kale chips snackwave microdosing cronut copper mug swag synth bitters letterpress glossier craft beer. Mumblecore bushwick authentic gochujang vegan chambray meditation jean shorts irony. Viral farm-to-table kale chips, pork belly palo santo distillery activated charcoal aesthetic jianbing air plant woke lomo VHS organic. Tattooed locavore succulents heirloom, small batch sriracha echo park DIY af. Shaman you probably haven’t heard of them copper mug, crucifix green juice vape single-origin coffee brunch actually. Mustache etsy vexillologist raclette authentic fam. Tousled beard humblebrag asymmetrical. I love turkey, I love my job, I love my friends, I love Chardonnay!
-Deae legum paulatimque terra, non vos mutata tacet: dic. Vocant docuique me plumas fila quin afuerunt copia haec o neque.
-On big screens, paragraphs and headings should not take up the full container width, but we want tables, code blocks and similar to take the full width.
-Scenester tumeric pickled, authentic crucifix post-ironic fam freegan VHS pork belly 8-bit yuccie PBR&B. I love this life we live in.
---This is a blockquote following a header. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
+Phone: 415-779-5431
This is a code block following a header.
-Next level leggings before they sold out, PBR&B church-key shaman echo park. Kale chips occupy godard whatever pop-up freegan pork belly selfies. Gastropub Belinda subway tile woke post-ironic seitan. Shabby chic man bun semiotics vape, chia messenger bag plaid cardigan.
-++Email: support@federated.computer
+
++We are here to help you, the Customer, get the most out of your Federated Core.
+
++All documentation for your Federated Core can be found at https://documentation.federated.computer. There you’ll find tips for how to use your Core and the various open source applications bundled with your Core.
+
Here are some quick pointers…
+++Note: Replace {domain.com} with the information you used when registering for the service.
+
Admin User
+There is an “admin” or administrative use that has access to everything on your Federated Core. Here are the credentials for that user.
+++User name = “admin@{domain.com}”, +Password = “{password}”
+
You should log into “Panel” (see next section) and change the password.
+Panel
+Your control panel for users for most Federated Core apps and services is here: https://panel.{domain.com}. You will log in with the admin user and, then change the password (and ideally, save this password in a safe place for later reference).
+You can also use Panel to create new user accounts for your team. You are able to give certain users administrative privileges, but please be cautious.
+Your email server has the following settings you can use to configure mobile and desktop email clients. Note: Nextcloud (next section) has a built-in web email client.
+SMTP: Server is “mail.{domain.com}” and the port is “465”. +IMAP: Server is “mail.{domain.com}” and the port is “993”.
+The user and password for the email service is the full email address and password as assigned in Panel (see above). Example: rupert@federated.computer, 56tasty23.
+Nextcloud: https://nextcloud.{domain.com}
+The Nextcloud suite (replacing Google Workplace) provides apps and services covering mail, calendar, contacts, notes, tasks, files, word processing, spreadsheets, slides, project management (deck), bookmarks, forms, team talk, pictures, and an activity monitor. The user and password for the Nextcloud service is the full email address and password as assigned in Panel (see above). Example: rupert@federated.computer, 56tasty23.
+There are a number of additional clients for mobile and desktop that work with Nextcloud. Please see https://documentation.federated.computer/nextcloud for more information and other documentation.
+Jitsi: https://jitsi.{domain.com}
+Jitsi (your Zoom replacement) is a wonderful video conferencing solution. We have tuned Jitsi so that your Core can handle video conferences up to 8 people. NOTE, at this time the user and password for the Jitsi service is the user name ALONE and password as assigned in Panel (see above). Example: rupert, 56tasty23.
+There are a number of mobile and desktop clients available to use with the Jitsi service. Please see https://documentation.federated.computer/jitsi for more information and other documentation.
+Element: https://element.{domain.com}
+Element (a Slack replacement) provides you the ability to chat and communicate in real time with those on your team and outside of the team.
+There are a number of mobile and desktop clients available to use with the Element service. Please see https://documentation.federated.computer/element for more information and other documentation.
+There are three services that do not use panel for user creation and management. This is for various reasons either based on the constraints for the current application, or so that you can share the system easily with users outside your team without giving access to other parts of your system.
+Listmonk: https://listmonk.{domain.com}
+Listmonk is a replacement for Mailchimp. You can set up and manage the email lists used to send out marketing messages. Listmonk is a single-user system and the user name is “listmonk@{domain.com}” and the password is {password}. For more information, please see the documentation https://documentation.federated.computer/listmonk.
+Baserow: https://baserow.{domain.com}
+Baserow (an Airtable replacement) allows you to create customized databases without writing any code. It’s an amazing product. The user authentication for Baserow is separate from Federated Core. To set up the service, log in as your “admin@{domain.com}” user with the correct password. You invite other users to Baserow within the service. For more information, please see the documentation https://documentation.federated.computer/baserow.
+Vaultwarden: https://vaultwarden.{domain.com}
+Vaultwarden is a password manager. The user authentication for Vaultwarden is separate from Federated Core. To set up the service, log in as your “admin@{your_domain.com}” user with the correct password. You invite other users to Vaultwarden within the service itself. For more information, please see the documentation https://documentation.federated.computer/vaultwarden.
+Gitea: https://gitea.{domain.com}
+Gitea is a code repository and management system similar to Github. The user authentication is seperate from Federated Core. To set up the service, log in as your “admin@{your_domain.com}” user with the correct password. You invite other users to Gitea within the service itself. For more information, please see the documentation https://documentation.federated.computer/gitea.
+VPN/Wireguard
+Your core comes with a very powerful VPN solution built using Wireguard. The following information is needed by your users so that they can use the VPN. Please treat this information as a very important secret. There are two important parts of the VPN:
| What | -Follows | -
|---|---|
| A table | -A header | -
| A table | -A header | -
| A table | -A header | -
There’s a horizontal rule above and below this.
-Here is an unordered list:
-And an ordered list:
+Address = {IP} +PrivateKey = {privatekey} +ListenPort = XXXXX +DNS = {IP}
And an unordered task list:
-And a “mixed” task list:
-And a nested list:
-Definition lists can be used with Markdown syntax. Definition headers are bold.
-Tables should have bold headings and alternating shaded rows.
-| Artist | -Album | -Year | -
|---|---|---|
| Michael Jackson | -Thriller | -1982 | -
| Prince | -Purple Rain | -1984 | -
| Beastie Boys | -License to Ill | -1986 | -
If a table is too wide, it should scroll horizontally.
-| Artist | -Album | -Year | -Label | -Awards | -Songs | -
|---|---|---|---|---|---|
| Michael Jackson | -Thriller | -1982 | -Epic Records | -Grammy Award for Album of the Year, American Music Award for Favorite Pop/Rock Album, American Music Award for Favorite Soul/R&B Album, Brit Award for Best Selling Album, Grammy Award for Best Engineered Album, Non-Classical | -Wanna Be Startin' Somethin', Baby Be Mine, The Girl Is Mine, Thriller, Beat It, Billie Jean, Human Nature, P.Y.T. (Pretty Young Thing), The Lady in My Life | -
| Prince | -Purple Rain | -1984 | -Warner Brothers Records | -Grammy Award for Best Score Soundtrack for Visual Media, American Music Award for Favorite Pop/Rock Album, American Music Award for Favorite Soul/R&B Album, Brit Award for Best Soundtrack/Cast Recording, Grammy Award for Best Rock Performance by a Duo or Group with Vocal | -Let’s Go Crazy, Take Me With U, The Beautiful Ones, Computer Blue, Darling Nikki, When Doves Cry, I Would Die 4 U, Baby I’m a Star, Purple Rain | -
| Beastie Boys | -License to Ill | -1986 | -Mercury Records | -noawardsbutthistablecelliswide | -Rhymin & Stealin, The New Style, She’s Crafty, Posse in Effect, Slow Ride, Girls, (You Gotta) Fight for Your Right, No Sleep Till Brooklyn, Paul Revere, Hold It Now, Hit It, Brass Monkey, Slow and Low, Time to Get Ill | -
Code snippets like var foo = "bar"; can be shown inline.
Also, this should vertically align with thisand this.
Code can also be shown in a block element.
-foo := "bar";
-bar := "foo";
-Code can also use syntax highlighting.
-func main() {
- input := `var foo = "bar";`
+PublicKey = {publickey}
+PresharedKey = {presharedkey}
+Endpoint = vpn.{domain.com}:XXXXX
+AllowedIPs = XXX.XX.XX.XX/XX
+Additional information about the VPN service can be found at https://documentation.federated.computer/vpn.
+
+Thank you for your support of Federated. We really appreciate it and hope you have a very successful time with Federated Core.
+
+
+Again, if we can be of any assistance, please don’t hesitate to get in touch. Don’t hesitate.
+
+
+Phone: 415-779-5431
+
+
+Email: support@federated.computer
+
+It’s your computer. Let’s make it work for you!
- lexer := lexers.Get("javascript")
- iterator, _ := lexer.Tokenise(nil, input)
- style := styles.Get("github")
- formatter := html.New(html.WithLineNumbers())
-
- var buff bytes.Buffer
- formatter.Format(&buff, style, iterator)
-
- fmt.Println(buff.String())
-}
-Long, single-line code blocks should not wrap. They should horizontally scroll if they are too long. This line should be long enough to demonstrate this.
-Inline code inside table cells should still be distinguishable.
-| Language | -Code | -
|---|---|
| Javascript | -var foo = "bar"; |
-
| Ruby | -foo = "bar"{ |
-
Small images should be shown at their actual size.
-
Large images should always scale down and fit in the content container.
-
The photo above of the Spruce Picea abies shoot with foliage buds: Bjørn Erik Pedersen, CC-BY-SA.
-- -
Add some sections here to see how the ToC looks like. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
-Inguina genus: Anaphen post: lingua violente voce suae meus aetate diversi. Orbis unam nec flammaeque status deam Silenum erat et a ferrea. Excitus rigidum ait: vestro et Herculis convicia: nitidae deseruit coniuge Proteaque adiciam eripitur? Sitim noceat signa probat quidem. Sua longis fugatis quidem genae.
-Tilde photo booth wayfarers cliche lomo intelligentsia man braid kombucha vaporware farm-to-table mixtape portland. PBR&B pickled cornhole ugh try-hard ethical subway tile. Fixie paleo intelligentsia pabst. Ennui waistcoat vinyl gochujang. Poutine salvia authentic affogato, chambray lumbersexual shabby chic.
-Plaid hell of cred microdosing, succulents tilde pour-over. Offal shabby chic 3 wolf moon blue bottle raw denim normcore poutine pork belly.
-Stumptown PBR&B keytar plaid street art, forage XOXO pitchfork selvage affogato green juice listicle pickled everyday carry hashtag. Organic sustainable letterpress sartorial scenester intelligentsia swag bushwick. Put a bird on it stumptown neutra locavore. IPhone typewriter messenger bag narwhal. Ennui cold-pressed seitan flannel keytar, single-origin coffee adaptogen occupy yuccie williamsburg chillwave shoreditch forage waistcoat.
-This is the final element on the page and there should be no margin below this.
-This is a placeholder page that shows you how to use this template site.
+This documentation is for users and administrators, not those wanting to install.
Information in this section helps your user try your project themselves.
-What do your users need to do to start using your project? This could include downloading/installation instructions, including any prerequisites or system requirements.
-Introductory “Hello World” example, if appropriate. More complex tutorials should live in the Tutorials section.
-Consider using the headings below for your getting started page. You can delete any that are not applicable to your project.
-Are there any system requirements for using your project? What languages are supported (if any)? Do users need to already have any software or tools installed?
-Where can your user find your project code? How can they install it (binaries, installable package, build from source)? Are there multiple options/versions they can install and how should they choose the right one for them?
-Is there any initial setup users need to do after installation to try your project?
-Can your users test their installation, for example by running a command or deploying a Hello World example?
+Federated Core is an easy-to-use, integrated suite of software. You use the Panel application to set up user accounts and these user accounts, for the most part, use their email and password to log into all other services.
+Please read the “Welcome to Federated Core” page for a detailed listing of services and the easy way to use each of them.
A short lead description about this content page. It can be bold or italic and can be split over multiple paragraphs.
This is a placeholder page that shows you how to use this template site.
+This documentation is for users and administrators, not those wanting to install.
This section is where the user documentation for your project lives - all the information your users need to understand and successfully use your project.
-For large documentation sets we recommend adding content under the headings in this section, though if some or all of them don’t apply to your project feel free to remove them or add your own. You can see an example of a smaller Docsy documentation site in the Docsy User Guide, which lives in the Docsy theme repo if you’d like to copy its docs section.
-Other content such as marketing material, case studies, and community updates should live in the About and Community pages.
-Find out how to use the Docsy theme in the Docsy User Guide. You can learn more about how to organize your documentation (and how we organized this site) in Organizing Your Content.
+All the documentation you could ever want. And if you want more, contribute and earn!
Here’s where your user finds out if your project is for them.
+Learn about Federated Core and all its potential for you and your team.
What does your user need to know to try your project?
+Welcome to Federated Core!
@@ -340,7 +339,7 @@Low level reference docs for your project.
This is a placeholder page that shows you how to use this template site.
+ +If your project has an API, configuration, or other reference - anything that users need to look up that’s at an even lower level than a single task - put (or link to it) here. You can serve and link to generated reference docs created using Doxygen,
+Javadoc, or other doc generation tools by putting them in your static/ directory. Find out more in Adding static content. For OpenAPI reference, Docsy also provides a Swagger UI layout and shortcode that renders Swagger UI using any OpenAPI YAML or JSON file as source.
A short lead description about this content page. It can be bold or italic and can be split over multiple paragraphs.
+This is a placeholder page. Replace it with your own content.
+ +Text can be bold, italic, or strikethrough. Links should be blue with no underlines (unless hovered over).
There should be whitespace between paragraphs. Vape migas chillwave sriracha poutine try-hard distillery. Tattooed shabby chic small batch, pabst art party heirloom letterpress air plant pop-up. Sustainable chia skateboard art party banjo cardigan normcore affogato vexillologist quinoa meggings man bun master cleanse shoreditch readymade. Yuccie prism four dollar toast tbh cardigan iPhone, tumblr listicle live-edge VHS. Pug lyft normcore hot chicken biodiesel, actually keffiyeh thundercats photo booth pour-over twee fam food truck microdosing banh mi. Vice activated charcoal raclette unicorn live-edge post-ironic. Heirloom vexillologist coloring book, beard deep v letterpress echo park humblebrag tilde.
+90’s four loko seitan photo booth gochujang freegan tumeric listicle fam ugh humblebrag. Bespoke leggings gastropub, biodiesel brunch pug fashion axe meh swag art party neutra deep v chia. Enamel pin fanny pack knausgaard tofu, artisan cronut hammock meditation occupy master cleanse chartreuse lumbersexual. Kombucha kogi viral truffaut synth distillery single-origin coffee ugh slow-carb marfa selfies. Pitchfork schlitz semiotics fanny pack, ugh artisan vegan vaporware hexagon. Polaroid fixie post-ironic venmo wolf ramps kale chips.
+++There should be no margin above this first sentence.
+Blockquotes should be a lighter gray with a border along the left side in the secondary color.
+There should be no margin below this final sentence.
+
This is a normal paragraph following a header. Knausgaard kale chips snackwave microdosing cronut copper mug swag synth bitters letterpress glossier craft beer. Mumblecore bushwick authentic gochujang vegan chambray meditation jean shorts irony. Viral farm-to-table kale chips, pork belly palo santo distillery activated charcoal aesthetic jianbing air plant woke lomo VHS organic. Tattooed locavore succulents heirloom, small batch sriracha echo park DIY af. Shaman you probably haven’t heard of them copper mug, crucifix green juice vape single-origin coffee brunch actually. Mustache etsy vexillologist raclette authentic fam. Tousled beard humblebrag asymmetrical. I love turkey, I love my job, I love my friends, I love Chardonnay!
+Deae legum paulatimque terra, non vos mutata tacet: dic. Vocant docuique me plumas fila quin afuerunt copia haec o neque.
+On big screens, paragraphs and headings should not take up the full container width, but we want tables, code blocks and similar to take the full width.
+Scenester tumeric pickled, authentic crucifix post-ironic fam freegan VHS pork belly 8-bit yuccie PBR&B. I love this life we live in.
+++This is a blockquote following a header. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
+
This is a code block following a header.
+Next level leggings before they sold out, PBR&B church-key shaman echo park. Kale chips occupy godard whatever pop-up freegan pork belly selfies. Gastropub Belinda subway tile woke post-ironic seitan. Shabby chic man bun semiotics vape, chia messenger bag plaid cardigan.
+| What | +Follows | +
|---|---|
| A table | +A header | +
| A table | +A header | +
| A table | +A header | +
There’s a horizontal rule above and below this.
+Here is an unordered list:
+And an ordered list:
+And an unordered task list:
+And a “mixed” task list:
+And a nested list:
+Definition lists can be used with Markdown syntax. Definition headers are bold.
+Tables should have bold headings and alternating shaded rows.
+| Artist | +Album | +Year | +
|---|---|---|
| Michael Jackson | +Thriller | +1982 | +
| Prince | +Purple Rain | +1984 | +
| Beastie Boys | +License to Ill | +1986 | +
If a table is too wide, it should scroll horizontally.
+| Artist | +Album | +Year | +Label | +Awards | +Songs | +
|---|---|---|---|---|---|
| Michael Jackson | +Thriller | +1982 | +Epic Records | +Grammy Award for Album of the Year, American Music Award for Favorite Pop/Rock Album, American Music Award for Favorite Soul/R&B Album, Brit Award for Best Selling Album, Grammy Award for Best Engineered Album, Non-Classical | +Wanna Be Startin' Somethin', Baby Be Mine, The Girl Is Mine, Thriller, Beat It, Billie Jean, Human Nature, P.Y.T. (Pretty Young Thing), The Lady in My Life | +
| Prince | +Purple Rain | +1984 | +Warner Brothers Records | +Grammy Award for Best Score Soundtrack for Visual Media, American Music Award for Favorite Pop/Rock Album, American Music Award for Favorite Soul/R&B Album, Brit Award for Best Soundtrack/Cast Recording, Grammy Award for Best Rock Performance by a Duo or Group with Vocal | +Let’s Go Crazy, Take Me With U, The Beautiful Ones, Computer Blue, Darling Nikki, When Doves Cry, I Would Die 4 U, Baby I’m a Star, Purple Rain | +
| Beastie Boys | +License to Ill | +1986 | +Mercury Records | +noawardsbutthistablecelliswide | +Rhymin & Stealin, The New Style, She’s Crafty, Posse in Effect, Slow Ride, Girls, (You Gotta) Fight for Your Right, No Sleep Till Brooklyn, Paul Revere, Hold It Now, Hit It, Brass Monkey, Slow and Low, Time to Get Ill | +
Code snippets like var foo = "bar"; can be shown inline.
Also, this should vertically align with thisand this.
Code can also be shown in a block element.
+foo := "bar";
+bar := "foo";
+Code can also use syntax highlighting.
+func main() {
+ input := `var foo = "bar";`
+
+ lexer := lexers.Get("javascript")
+ iterator, _ := lexer.Tokenise(nil, input)
+ style := styles.Get("github")
+ formatter := html.New(html.WithLineNumbers())
+
+ var buff bytes.Buffer
+ formatter.Format(&buff, style, iterator)
+
+ fmt.Println(buff.String())
+}
+Long, single-line code blocks should not wrap. They should horizontally scroll if they are too long. This line should be long enough to demonstrate this.
+Inline code inside table cells should still be distinguishable.
+| Language | +Code | +
|---|---|
| Javascript | +var foo = "bar"; |
+
| Ruby | +foo = "bar"{ |
+
Small images should be shown at their actual size.
+
Large images should always scale down and fit in the content container.
+
The photo above of the Spruce Picea abies shoot with foliage buds: Bjørn Erik Pedersen, CC-BY-SA.
++ +
This is a placeholder page that shows you how to use this template site.
+This documentation is for users and administrators, not those wanting to install.
The Overview is where your users find out about your project. Depending on the size of your docset, you can have a separate overview page (like this one) or put your overview contents in the Documentation landing page (like in the Docsy User Guide).
-Try answering these questions for your user in this page:
-Introduce your project, including what it does or lets you do, why you would use it, and its primary goal (and how it achieves it). This should be similar to your README description, though you can go into a little more detail here if you want.
-Help your user know if your project will help them. Useful information can include:
+Federated Core is like a Linux distribution in the cloud. It includes a number of leading open-source projects fully integrated so that users don’t have to be systems administrators.
+We have tried to cover the high-level basics of what you will need to know to get the most out of your Federated Core. That includes:
What is it good for?: What types of problems does your project solve? What are the benefits of using it?
+Getting Started: This is the place to go if you’re short on time. We run you through the very bare minimum of what your need to know to use your Federated Core.
What is it not good for?: For example, point out situations that might intuitively seem suited for your project, but aren’t for some reason. Also mention known limitations, scaling issues, or anything else that might let your users know if the project is not for them.
+Core Applications: Want to learn more and in-depth about each of the user-facing applications that are part of Federated Core? These pages detail application-by-application what is available and the capabilities of each.
What is it not yet good for?: Highlight any useful features that are coming soon.
+Client Applications: You can connect and your your Federated Core with applications native to your PC, Macintosh or mobile phone of whatever variety. This is a list of some of those applications and how to connect them.
Give your users next steps from the Overview. For example:
List to our podcast!
+Listen to our podcast!
You can contribute to Sovereign Reset through a Pull Request contribution on our Gitea or sending contributions to editor@sovereignreset.com. New users are always welcome!
+You can contribute to Federated Documentation through a Pull Request contribution on our Gitea or sending contributions to editor@sovereignreset.com. New users are always welcome!
For self-sovereign news, interviews, tips, engagement.
What does your user need to know to try your project?
+Welcome to Federated Core!
A short lead description about this content page. It can be bold or italic and can be split over multiple paragraphs.
diff --git a/public/tags/docs/index.xml b/public/tags/docs/index.xml index 823a477..59b715b 100644 --- a/public/tags/docs/index.xml +++ b/public/tags/docs/index.xml @@ -26,34 +26,18 @@ <div class="pageinfo pageinfo-primary"> -<p>This is a placeholder page that shows you how to use this template site.</p> +<p>This documentation is for users and administrators, not those wanting to install.</p> </div> -<p>Information in this section helps your user try your project themselves.</p> -<ul> -<li> -<p>What do your users need to do to start using your project? This could include downloading/installation instructions, including any prerequisites or system requirements.</p> -</li> -<li> -<p>Introductory “Hello World” example, if appropriate. More complex tutorials should live in the Tutorials section.</p> -</li> -</ul> -<p>Consider using the headings below for your getting started page. You can delete any that are not applicable to your project.</p> -<h2 id="prerequisites">Prerequisites</h2> -<p>Are there any system requirements for using your project? What languages are supported (if any)? Do users need to already have any software or tools installed?</p> -<h2 id="installation">Installation</h2> -<p>Where can your user find your project code? How can they install it (binaries, installable package, build from source)? Are there multiple options/versions they can install and how should they choose the right one for them?</p> -<h2 id="setup">Setup</h2> -<p>Is there any initial setup users need to do after installation to try your project?</p> -<h2 id="try-it-out">Try it out!</h2> -<p>Can your users test their installation, for example by running a command or deploying a Hello World example?</p> +<p>Federated Core is an easy-to-use, integrated suite of software. You use the <strong>Panel</strong> application to set up user accounts and these user accounts, for the most part, use their email and password to log into all other services.</p> +<p>Please read the “Welcome to Federated Core” page for a detailed listing of services and the easy way to use each of them.</p>A short lead description about this content page. It can be bold or italic and can be split over multiple paragraphs.
diff --git a/public/tags/sample/index.xml b/public/tags/sample/index.xml index 48f84d8..e302c04 100644 --- a/public/tags/sample/index.xml +++ b/public/tags/sample/index.xml @@ -15,7 +15,7 @@Welcome to Federated Core!
+What does your user need to know to try your project?
-A short lead description about this content page. It can be bold or italic and can be split over multiple paragraphs.
diff --git a/public/tags/test/index.xml b/public/tags/test/index.xml index 45393ef..603f1c3 100644 --- a/public/tags/test/index.xml +++ b/public/tags/test/index.xml @@ -15,45 +15,7 @@