Skip to content

Latest commit

 

History

History
57 lines (46 loc) · 3.36 KB

README.md

File metadata and controls

57 lines (46 loc) · 3.36 KB
Raw

sst-docs

This repo provides the Docusaurus source code for sst-docs. This website is NOT THE MAIN SST WEBSITE, but a subsidiary website containing documentation focusing on usage of SST.

  • The main website is located at http://sst-simulator.org/
  • This subsidiary website is located at http://sst-simulator.org/sst-docs
  • This website documents the SST capabilities provided and supported by the SST team. Community-provided components may have their own documentation which is linked to from the main SST site's "Community" page.

This subsidiary website is developed using Docusaurus, refer to the Docusaurus Documentation for details on the how to develop content and the file structure of the source code.

The branches of the repo have the following purposes:

  • The master branch of this repo contains Docusaurus source for the website.
  • The gh-pages branch contains the built static website that is automatically created by Docusaurus operations.

How to develop content

  • The SST Team is continually updating this website.
    • For minor updates to existing documentation (corrections, updates, etc.), open a PR with the proposed changes
    • For new documentation contributions, open an Issue on the repository prior to submitting a PR. This will give the SST community an opportunity to let you know if documentation on the same topic is already in progress.

General instructions when updating the sst-docs content:

  • Ensure Node is installed on development machine.
  • Clone the sst-docs repository.
  • Create a feature branch from master on your local repo.
  • cd into sst-docs/website
  • Initialize Docusaurus
    • > npm install
  • Test local hosting operation
    • > npm start
    • NOTE: May need to run > export NO_PROXY=localhost if behind a proxy (see Docusaurus Proxy Info )
    • control-C to exit local hosting.
  • Make changes to the source and test with local hosting
    • > npm start
  • Add/Commit final changes back to the feature branch of your local repo
  • Push feature branch up to your fork of the sst-docs repo
  • Generate a pull request from your feature branch/fork to the master branch of sst-docs repo
  • Members of the SST team will:
    • Review changes for areas including:
      • Accuracy
      • Relevance to SST and usefulness to SST users
      • Future maintainability (e.g., avoiding too much duplication of information)
      • Grammar/spelling/etc
      • Presentation
    • Merge the PR once accepted
    • Build the website and push it to the gh-pages branch.

SST-Team Tasks

When a pull request to master branch from a feature branch is generated:

  • Following the general operations above and test/review the changes to the website
  • Review changes and merge the pull request into master branch.
  • run the following command from the sst-docs/website directory:
    • > GIT_USER=<github_user_name> CURRENT_BRANCH=master USE_SSH=true npm run deploy
  • Wait approx 5-10 minutes and check that content is updated at http://sst-simulator.org/sst-docs