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

Transform links to subutai wiki pages to point to RTD generated pages #21

Open
akarasulu opened this issue Mar 7, 2018 · 1 comment
Assignees
Milestone

Comments

@akarasulu
Copy link
Contributor

Problem

Some wiki pages point to each other with links. When the RTD page is generated, those links still point back to GitHub Wiki pages and users navigate off of our website onto the GitHub Wiki and this produces some discontinuity.

Solution

During RTD content generation we need to modify URL's that point to the same Wiki so they point to the transformed content in RTD. The following URL pattern represents a GitHub Wiki page cross reference in the same project:

ORG=subutai-io
PRJ=agent
'@wiki/images@b; s@https://github.com/$ORG/$PRJ/wiki/\(.*\)@https://docs.subutai.io/Projects/$PRJ/(\1)g'

With cross project links we have the following substitution:

ORG=subutai-io
'@wiki/images@b; s@https://github.com/$ORG/\(.*\)/wiki/\(.*\)@https://docs.subutai.io/Projects/(\1)/(\2)g'

It's perhaps best to make substitutions on the generated restructuredText files instead of making them on the md files of the wiki since we will throw away the rst files.

@akarasulu akarasulu added this to the Soft Launch milestone Mar 7, 2018
@akarasulu akarasulu self-assigned this Mar 7, 2018
@efeefe
Copy link
Member

efeefe commented Dec 21, 2018

Closing this, as we're incorporating (after grammar/coherence review) docs from wiki into the GRAV-based docs website. We will occasionally keep whatever more dynamic contents into the wiki, but contextualize when linking to it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants