[FOLIO-2007] Embed .md files in Confluence pages Created: 09/May/19 Updated: 03/Jun/20 Resolved: 24/May/19 |
|
| Status: | Closed |
| Project: | FOLIO |
| Components: | None |
| Affects versions: | None |
| Fix versions: | None |
| Type: | New Feature | Priority: | P3 |
| Reporter: | Jag Goraya | Assignee: | Peter Murray |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original estimate: | Not Specified | ||
| Attachments: |
|
||||||||||||||||
| Issue links: |
|
||||||||||||||||
| Sprint: | |||||||||||||||||
| Description |
|
We've got a bunch of modules that we look after in ERM, and I'm interested to present the latest release notes for easy access within our wiki space. That would mean installing / configuring a plugin that supports embedding .md files from Github. There are some suggested ones in this thread: https://community.atlassian.com/t5/Confluence-questions/Embed-md-file-from-Github-in-Confluence-page/qaq-p/407068 This would also help with improving visibility (without duplication) of our onboarding (and ongoing) documentation, and I can imagine may also be useful for FOLIO wide release note presentation. |
| Comments |
| Comment by Peter Murray [ 13/May/19 ] |
|
Ah, I'm remembering some history on this. We had tried Mohami's Markdown Extensions for Confluence a couple of years ago and found it conflicted with something else that was running on the Confluence server at the time. I don't think we've revisited this for a while, and I don't believe we tried the Bob Smith Markdown for Confluence. Of the two, it seems like the Bob Smith one is more feature-rich. What do you think John Malconian – should we give it another try? |
| Comment by John Malconian [ 13/May/19 ] |
|
Sure Peter Murray. Did you want to try installing the plugin or shall I? |
| Comment by Peter Murray [ 14/May/19 ] |
|
I'll give it a shot. |
| Comment by Peter Murray [ 14/May/19 ] |
|
Okay – I added the plug-in and put a temporary site-wide notice on wiki.folio.org to let people know that they can report problems here. |
| Comment by Jag Goraya [ 15/May/19 ] |
|
Thanks for setting this up Peter Murray. I've had a go using these, but I'm not getting the results I'd expect. I have created https://folio-org.atlassian.net/wiki/display/ERM/ERM+Release+Notes, so feel free to check / change settings out there.
A couple of areas I'm not sure I've got right:
Suggestions / advice welcome. Thanks. Jag |
| Comment by Peter Murray [ 16/May/19 ] |
|
Jag – I'm at a FOLIO meet-up in Michigan tomorrow, so I won't be able to get back to this until Friday. I'll take a look then. |
| Comment by Cate Boerema (Inactive) [ 16/May/19 ] |
|
Hi all. This notice is pretty annoying in the wiki. You close it and it displays again every time you load a new page. Per the message, the notice is somehow related to this issue. |
| Comment by Peter Murray [ 16/May/19 ] |
|
Cate Boerema: I removed the banner. Although the add-on may not be working as intended, it doesn't seem to have any ill effects. |
| Comment by Peter Murray [ 16/May/19 ] |
|
Jag Goraya: I had a moment to look at the page this morning. I replaced the URL with https://github.com/folio-org/ui-licenses/raw/master/README.md and I think it is working okay now. This may or may not be the best way to do this – I'll look more at profiles tomorrow. |
| Comment by Jag Goraya [ 16/May/19 ] |
|
Peter Murray Fab - that works grand, I'm happy with it and for you to close this issue. Thanks very much |
| Comment by Peter Murray [ 17/May/19 ] |
|
Excellent! Glad to hear it. I'll arrange for the gratis open source project license for the plugin. |
| Comment by David Crossley [ 24/May/19 ] |
|
The license key has been received and installed.
|