Skip to content

Onboarding

Github repo

To onboard your own github repo into this site you will need to make edits to https://github.com/fastly/sigsci-agent-docs

Top-level Changes

  • Update repos.yml to include your site and what github repos you need to download from (e.g. your site might be a3f, agent-and-modules, cloud-waf or ng-waf-edge)
  • Add the directory you specified in top-level repos.yml node into sigsci-agent-docs/sites
  • Update sites/mkdocs.yml to include your new site in the navigation

Create your own Personal Access Token

Create a personal access token for yourself in github by going to your own profile then - Settings -> Developer Settings -> Personal access tokens -> Generate new token

Make sure the token has admin:repo_hook, repo, workflow permissions and you Configure SSO (authorize) for both fastly and signalsciences

Target github repo

  • Add a docs.yml file to specify the files you are importing and the navigation you want in the target repo you are importing (e.g. docs.yml)
  • Add a github action if you want any updates to site to get published to elevation (e.g. .github/workflows/docs.yml). You should be able to copy the exact file to create the github action.

Adding your site

python ./main.py --secret $PERSONAL_ACCESS_TOKEN --repo all --site $NEW_SITE
  • Check that the repos have been correctly downloaded your docs directory (e.g. agent-and-modules/docs)

Docker build

  • Update the Dockerfile as appropriate to copy the docs and mkdocs.yml files to the appropriate site/directory in nginx
  • Create your docker image and run it
docker image build -t docs-demo:0.0.1 .
docker run -dp 3000:8080 docs-demo:0.0.1
  • Check the generated site at localhost:3000 and see if your changes look right
  • Once this is all done, open a PR and get it reviewed and merged