search

keptn-sandbox / new-keptn-docs-engine

GSoC 2022 Project: New Documentation Site Engine
https://keptn-experimental-docs-site.netlify.app/
Apache License 2.0
6 stars 2 forks source link

Enable `Edit` button only on pages whose source of truth is the documentation site #22

Open vadasambar opened 2 years ago

vadasambar commented 2 years ago

Problem statement

We are supporting Editing all the pages on our documentation website (PR) but this might create a problem where a user wants to edit the auto-generated CLI docs (for example) or docs pulled from another repository (i.e., actual source sits somewhere else) but the edits would be over-written in the next auto-generation (or pull from the source).

Describe the solution you'd like

The Edit button should be shown only on the pages which sit in our documentation site repo and are written by hand.

Describe alternatives you've considered

We could put a big warning against docs where the source of truth is not the documentation site repo.

Additional context

Related: https://github.com/keptn-sandbox/new-keptn-docs-engine/issues/13

shivam-Purohit commented 1 year ago

Hey @vadasambar can I work on this issue?

vadasambar commented 1 year ago

Sure. cc: @iamrajiv because he wrote most of the code in this repo.

vadasambar commented 1 year ago

@iamrajiv , I am not sure if we support auto-generation of docs using CLI in this repo yet and if the answer is no, this issue might be irrelevant (we might have created this issue with future scope in mind)