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

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

Open
vadasambar opened this issue Aug 22, 2022 · 3 comments
Labels
enhancement New feature or request

Comments

@vadasambar
Copy link

vadasambar commented Aug 22, 2022

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: #13

@vadasambar vadasambar added the enhancement New feature or request label Aug 22, 2022
@vadasambar vadasambar changed the title Enable Edit button only on pages which aren't auto-generated using CI Enable Edit button only on pages whose source of truth is the documentation site Aug 22, 2022
@shivam-Purohit
Copy link

Hey @vadasambar can I work on this issue?

@vadasambar
Copy link
Author

vadasambar commented Nov 3, 2022

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

@vadasambar
Copy link
Author

@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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants