Skip to content

Commit

Permalink
Fix edit/view links to use the docs branch
Browse files Browse the repository at this point in the history
  • Loading branch information
rcroft-work committed Mar 13, 2024
1 parent 61a6e6d commit 2455120
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/about/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ Companies, such as Microsoft and GitLab, have migrated to a documentation-as-cod

This document proposes we consider adopting a documentation-as-code approach for our public facing documentation, especially the Developer Portal. Considering, EUC is migrating to GitHub for its Source code management (SCM), we propose using GitHub's Documentation-as-Code offering called GitHub Pages.

A rough proof-of-concept has been created using GitHub, GitHub Pages, and MkDocs - it is available here: [EUC Developer Portal PoC](https://rcroft-work.github.io/EUCDigitalWorkspace.github.io/)

??? Info "Teams using Docs-as-Code approach"

A number of VMware teams have been using this approach for the public documentation - see [Appendix A](#appendix-a) for examples.
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use_directory_urls: true

# Repository
repo_url: https://github.com/rcroft-work/eucdigitalworkspace.github.io
edit_uri: edit/main/docs/
edit_uri: edit/docs/docs/

# site_name: !!python/object/apply:os.getenv ["CI_PROJECT_PATH"]
# repo_url: !!python/object/apply:os.getenv ["CI_PROJECT_URL"]
Expand Down

0 comments on commit 2455120

Please sign in to comment.