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

Possibility of adding header/footer to wiki pages to set expectations of readers? #13

Open
petemounce opened this issue Mar 22, 2020 · 0 comments
Labels
enhancement New feature or request v4

Comments

@petemounce
Copy link

petemounce commented Mar 22, 2020

I'd like to use this tool to publish documentation from source-control, via a cronjob / CI.

I'd therefore like to restrict wiki-editing of the content, which I think I can do via confluence permissions.

I'd like to set expectations for the people who read the docs via the confluence wiki:

  • I'd like to make it clear where the documentation comes from, so that they know where to make any edits - I was thinking a link to my source control and a little prose inside a callout
    • I'd like to add some metadata to the page in a callout that says which version control reference the page was published from
  • I'd like to warn people that comments will not persist (I just made a comment on a published page, and it was resolved after I republished (I did not change the markdown's content before republish))
    • unless there's a way to keep them
      • but this is definitely not a problem for me personally since we do doc-discussions inside pull requests and slack really
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request v4
Projects
None yet
Development

No branches or pull requests

2 participants