search

bcgov / common-hosted-form-service-techdocs

Technical documentation for the Common Hosted Forms Service (CHEFS).
Apache License 2.0
0 stars 5 forks source link

add edit button #24

Closed MonicaG closed 5 months ago

MonicaG commented 6 months ago

Updated the mkdocs yaml file to include the edit and issue buttons. This will allow a user to create a GitHub issue or PR for the given page.

I also removed the mermaid plugin as a plugin is used now instead on the devhub side to render mermaid diagrams

MonicaG commented 5 months ago

Hi! Just following up on this PR. Is it ok to merge? Thank you!

WalterMoar commented 5 months ago

Hi! Just following up on this PR. Is it ok to merge? Thank you!

@vijaivir, @bhuvan-aot - thoughts on this? I'm not sure what it does :D

MonicaG commented 5 months ago

@WalterMoar - the change adds an edit/issue button to the documentation pages. The Onboarding to application monitoring with Sysdig page has an example of it. Next to the title on the page, there is an icon of a page with a pencil. Clicking it will let a user open a PR or Issue on the repo. This lets users provide suggested edits to the page.

This PR is to add that functionality. Each page of this documentation would have that button.

MonicaG commented 5 months ago

@vijaivir, @bhuvan-aot @WalterMoar - is it ok for this PR to be merged?

MonicaG commented 5 months ago

@bhuvan-aot - thank you for the approval. Do you have a timeline on when this PR will be merged?

Thanks!