Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Codespaces and website docs #77

Merged
merged 21 commits into from
Aug 31, 2023
Merged

Codespaces and website docs #77

merged 21 commits into from
Aug 31, 2023

Conversation

agardnerIT
Copy link
Collaborator

@agardnerIT agardnerIT commented Aug 2, 2023

This PR

  • Reworks the docs in the walkthrough directory to be compatible with the codespaces / argo way of working
  • Files in /docs will build the website
  • mkdocs.yml is the metadata for the website

The site uses the mkdocs-macros-plugin plugin to allow the use of extras and thus "markdown include variables" such as {{ foo }} being dynamically replaced by looking up:

mkdocs.yml

extras:
 foo: "bar"

Note: Merging this PR won't be enough to have a functioning website.
The GitHub Action will take the .md files from /docs and transform to HTML then create and push to gh-pages branch.

The repo admin needs to go into the repo settings and set up GitHub pages to build from the gh-pages.

Only then will a website be available. I believe the URL will be: https://dynatrace-oss.github.io/progressivedelivery-masterclass

Signed-off-by: Adam Gardner <[email protected]>
Signed-off-by: Adam Gardner <[email protected]>
Signed-off-by: Adam Gardner <[email protected]>
Signed-off-by: Adam Gardner <[email protected]>
Signed-off-by: Adam Gardner <[email protected]>
Signed-off-by: Adam Gardner <[email protected]>
@heckelmann
Copy link
Collaborator

That's great @agardnerIT!

Maybe you can check on your environment Grafana?
It seems like the issue with grafana and the forwarded ports in codespaces is gone and the origin not allowed-Error solved, so we would not need the GH CLI anymore.

Signed-off-by: Adam Gardner <[email protected]>
@agardnerIT agardnerIT changed the title Codespaces docs Codespaces and website docs Aug 10, 2023
@heckelmann heckelmann merged commit 430f880 into dynatrace-oss:main Aug 31, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants