Skip to content

Creating a Doc Site

To create a new doc site, there are a number of items you need to set up before you can start adding content.

Prerequisites

Make sure your device meets the system requirements

Set up your dev environment

Learn the basics about creating and building doc sites

Instructions

Here's how to create a new doc site.

  1. Open a web browser and access the Arundo project in GitHub.

  2. Create a repo for the doc site.

    • Add the repo with a README and MIT license.
    • Add a description that explains the usage of the docs.

  3. Open GitHub Desktop.

  4. Clone the new repo you added to your local device and fetch the content.

  5. Open the arundo-docs-theme repo, download it to your local device, and extract the files into the local directory for the new doc site.

    • Select to skip replacing the README and LICENSE files.

  6. Open the local directory of the new doc site in a source code editor.

    You should now see the following folders and files.

    New repo files and folders

  7. Move back to GitHub Desktop and make sure the doc site is selected as the current repository.

  8. Commit the changes to master.

  9. Push the changes to origin.

    The doc site skeleton is now built and saved to GitHub. You can now add and remove content in the docs folder as necessary.

  10. Open the DevSecOps board in Jira and add a ticket to create a static web app for the docs site in Azure.

Next Steps

Add content to the doc site

Last update: June 26, 2020