Skip to main content

Deploying static doc site📜

Static doc site refers to a site very similar to the one you're browsing. It can be developed using various tools, including but not limited to:

  • Docusaurus template
  • Jekyll
  • Gatsby
  • Sphinx
  • etc.

However, to make the static page available, in addition to creating the actual site and its repository, one also needs to:

  • create a distinct service provider for it at terraform-github-repo-credentials

    • you can check this commit as an example
  • then create a reference to the new repository at terraform-static-docs-webpage

    • see this commit for reference
  • add deployment action to the repository, example of it can be found here

  • once all of these changes are made, the platform team still needs to approve the new SP's access to the MS accounts and if that's not the case you would see the following error message trying to access your site

    software package error

  • if more than 4 hours have passed since those PRs have been merged, ping them at the #team-platform Slack channel