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

Add a note that docs are generated #38

Open
barrettj12 opened this issue Jan 16, 2023 · 4 comments
Open

Add a note that docs are generated #38

barrettj12 opened this issue Jan 16, 2023 · 4 comments

Comments

@barrettj12
Copy link

While we can and should allow users to edit docs on Discourse (#17), we should probably encourage them to edit the source Markdown files instead. Maybe we could (have the option to) add a note to each auto-generated doc on Discourse:

This document was automatically published from a Markdown file on GitHub. To edit this doc, please open a pull request here.

and provide a link to the Markdown file on GitHub.

@jdkandersson
Copy link
Contributor

jdkandersson commented Jan 17, 2023

Maybe that can be the first response after the topic post?

@barrettj12
Copy link
Author

I'd prefer a note on the original topic post (maybe at the end), as I don't think responses are shown on juju.is / charmhub docs.

@jdkandersson
Copy link
Contributor

Let me know your thoughts as well, the idea was that it shouldn't be shown on the documentation since the audience there is most likely more on the read side. If they do go to edit, they may end up on discourse and then see the note regarding editing the documentation.

It is already possible to include a note in the documentation project by project by adding that link to every file, which could be done using automation as well. I'm hesitant to automatically add it to the documentation itself since perhaps not every project wants to have that note included in their documentation

@barrettj12
Copy link
Author

Okay, I'm with you now. This sounds like a good approach:

first response after the topic post

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

No branches or pull requests

2 participants