Skip to content

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

@akarasulu

Description

@akarasulu

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.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions