These basic sample guidelines assume that your Docsy site is deployed using Netlify and your files are stored in GitHub. You can use the guidelines “as is” or adapt them with your own instructions: for example, other deployment options, information about your doc project’s file structure, project-specific review guidelines, versioning guidelines, or any other information your users might find useful when updating your site. Kubeflow has a great example.
-Don’t forget to link to your own doc repo rather than our example site! Also make sure users can find these guidelines from your doc repo README: either add them there and link to them from this page, add them here and link to them from the README, or include them in both locations.
+This documentation is create using Docsy and Hugo and then pushed to a Gitea repository on our Federated Core. A webhook in Gitea then pushes the public folder to Caddy where it is published to the world-wide-web.
We use Hugo to format and generate our website, the -Docsy theme for styling and site structure, -and Netlify to manage the deployment of the site. -Hugo is an open-source static site generator that provides us with templates, +
We use Hugo to format and generate our website, and publish it through Gitea running on our Federated Core. This documentation is created used the Docsy template.
+Hugo is an open-source static site generator that provides us with templates, content organisation in a standard directory structure, and a website generation engine. You write the pages in Markdown (or HTML if you want), and Hugo wraps them up into a website.
All submissions, including submissions by project members, require review. We -use GitHub pull requests for this purpose. Consult -GitHub Help for more -information on using pull requests.
-Here’s a quick guide to updating the docs. It assumes you’re familiar with the -GitHub workflow and you’re happy to use the automated preview of your doc -updates:
-If you’ve just spotted something you’d like to change while using the docs, Docsy has a shortcut for you:
-If you want to run your own local Hugo server to preview your changes as you work:
-Follow the instructions in Getting started to install Hugo and any other tools you need. You’ll need at least Hugo version 0.45 (we recommend using the most recent available version), and it must be the extended version, which supports SCSS.
-Fork the Goldydocs repo repo into your own project, then create a local copy using git clone. Don’t forget to use --recurse-submodules or you won’t pull down some of the code you need to generate a working site.
git clone --recurse-submodules --depth 1 https://github.com/google/docsy-example.git
-Run hugo server in the site root directory. By default your site will be available at http://localhost:1313/. Now that you’re serving your site locally, Hugo will watch for changes to the content and automatically refresh your site.
Continue with the usual GitHub workflow to edit files, commit them, push the -changes up to your fork, and create a pull request.
-If you’ve found a problem in the docs, but you’re not sure how to fix it yourself, please create an issue in the Goldydocs repo. You can also create an issue about a specific page by clicking the Create Issue button in the top right hand corner of the page.
-Please send an email to support@federated.computer with your interest to contribute to the documentation. If we decide to collaborate, we are willing to compensate you for your contributions with free Federated services, merchandise, even BTC. Please get in touch.
+How to contribute to the docs
+How to contribute to the Federated Core documentation.
We will have other issues covered here, in time.