[DOCU-1675] Embed remote examples to content types docs Created: 30/Aug/18 Updated: 09/Mar/21 Resolved: 09/Mar/21 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Task | Priority: | Neutral |
| Reporter: | Christoph Meier | Assignee: | Ashraf Khamis |
| Resolution: | Obsolete | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Template: |
|
| Acceptance criteria: |
Empty
|
| Task DoR: |
Empty
|
| Date of First Response: | |
| Epic Link: | Content Types phase 2 |
| Sprint: | Docu Sprint 58, Docu Sprint 59 |
| Story Points: | 0.5 |
| Description |
|
Examples for the CT docs are the result of a collaboration of doc team and VN core team. Finally, the docs will reside in a Bitbucket repo. Current doc pages do not yet embed the remote files since they are not yet there. But besides the final file embedding, some doc pages are already or nearly finished. In order to allow to close some of the related tickets of this epic - I have created this ticket. Files which contain examples and must embed the remotely located files:
|
| Comments |
| Comment by Christoph Meier [ 14/Sep/18 ] |
|
Now embedding the examples from the temp. repo https://git.magnolia-cms.com/users/cmeier/repos/content-type-examples This way I can make sure that the embedding works as expected. Note that I sometimes want to embed just snippets of a file - which sometimes makes it necessary to have "special makers" as YAML comments to enable regex to get the desired snippet. This should help to avoid later edits on the files, once they are transported to their final repos. (Keep in mind that every commit on UI will trigger tons of build processes on jenkins.) Changed the code macros remote embedding code from https://git.magnolia-cms.com/users/cmeier/repos/content-type-examples in these pages:
|
| Comment by Christoph Meier [ 03/Oct/18 ] |
|
I have dropped this from Docu Sprint 60. |
| Comment by Christoph Meier [ 19/Nov/18 ] |
|
I am reopening that one - but removing the fixVersion |
| Comment by Ashraf Khamis [ 09/Mar/21 ] |
|
Closing the ticket as Obsolete after our product documentation has been migrated to AsciiDoc and Antora. |