go-markdown2confluence icon indicating copy to clipboard operation
go-markdown2confluence copied to clipboard

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

Open petemounce opened this issue 4 years ago • 0 comments

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

petemounce avatar Mar 22 '20 14:03 petemounce