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.

Sign up for GitHub

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

Jump to bottom

Convert cross-references into links in documentation #1358

Closed
kowen-rh opened this issue Jul 2, 2020 · 1 comment
Closed

Convert cross-references into links in documentation #1358

kowen-rh opened this issue Jul 2, 2020 · 1 comment
Assignees
@kowen-rh
Labels
kind/documentation Documentation issues. priority/major size/M
Projects
Documentation

Comments

@kowen-rh
Copy link
Contributor

kowen-rh commented Jul 2, 2020

In order to facilitate using some of our documentation modules between both the Getting Started Guide and the Release Notes, we should use link:[] rather than <<xref>> in the documentation.
@kowen-rh kowen-rh self-assigned this Jul 2, 2020
@kowen-rh kowen-rh added this to To do in Documentation Jul 2, 2020
kowen-rh added a commit to kowen-rh/crc that referenced this issue Jul 9, 2020
@kowen-rh
Issue crc-org#1358 Use links instead of xrefs in docs
1f02c3a 
This allows us to use modules in multiple assemblies while ensuring that
the links in each module point to the correct assembly context. This
will enable us to use some modules in the Release Notes assembly in
addition to the Getting Started Guide (namely the system requirements).
@kowen-rh kowen-rh mentioned this issue Jul 9, 2020
Merged
@kowen-rh kowen-rh moved this from To do to In progress in Documentation Jul 9, 2020
gbraad pushed a commit that referenced this issue Jul 10, 2020
@kowen-rh @gbraad
Issue #1358 Use links instead of xrefs in docs
1904e3a 
This allows us to use modules in multiple assemblies while ensuring that
the links in each module point to the correct assembly context. This
will enable us to use some modules in the Release Notes assembly in
addition to the Getting Started Guide (namely the system requirements).
@kowen-rh kowen-rh moved this from In progress to Done in Documentation Jul 10, 2020
@kowen-rh
Copy link
Contributor Author

Fixed by #1374.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kowen-rh kowen-rh

Labels
kind/documentation Documentation issues. priority/major size/M
Projects
No open projects
Documentation
  
Done
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kowen-rh