-
Notifications
You must be signed in to change notification settings - Fork 183
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
Fix broken uri-use page links in updated reference docs of develop branch #1518
Fix broken uri-use page links in updated reference docs of develop branch #1518
Conversation
a5429d8
to
b42f640
Compare
I talked with Dave about this yesterday afternoon and it really seems we do not want to ignore non-existent pages, but revive the attempt to use the remapping feature and circle back with the upstream developer re lycheeverse/lychee#683 (similar use case, just different example as it pertains to our CI/CID checking). Will work towards quickly fixing that. Also removing relative paths that will confuse this remapping (the erroneous |
6ca69ae
to
22d5253
Compare
@david-waltermire-nist I am hopefully running this one for the last time. Even with updated configuration to look at local files (and avoid this inception problem with staged new files that are check-in but not "published" in
From this last run before force-pushed commit on Metaschema |
Recently added links in documentation refer to href="/OSCAL" and not href="https://pages.nist.gov/OSCAL" in error or to simplify link gen and lookup. Now that we are remapping the full URLs to local paths and offsets for link-checking, we want these to be consistent across the board in Metaschema after usnistgov#1263.
856e5bd
to
2d93008
Compare
2d93008
to
61540e6
Compare
@david-waltermire-nist this is finally ready for review. It did not occur to me what you were suggesting earlier today, but now think I understand. To avoid monkeying around further to override branch and remote protections. I use the local docker container to not only change Metaschema url definitions to relative, and update the config to have This is good to go. I know it is unfortunately I must manually add in the model reference docs (from running Ironically, in a way this relates to #1447 in an edge case we usually don't need, but I will keep that in mind for the future. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@aj-stein-nist I'd really like to find a way to not change the absolute links in the metaschema from https://pages.nist.gov/OSCAL/
to /
. This make the links unusable for someone browsing a metaschema. They have no way of knowing where they point.
02a17c3
to
5861ba4
Compare
Done and done. It appears that the issues I thought I had doing that before were the other issues you had pointed out to me while I was out on leave. Also, @david-waltermire-nist, as discussed in the other PR, all is working except for the other issue that I fixed with bad, old Markdown links (to keep it organized and logically separate) in #1534. If you want to point there here instead of |
5861ba4
to
cb0682f
Compare
cb0682f
to
d5c3f7b
Compare
…anch (#1518) * Fix documentation relative paths in Metaschema Recently added links in documentation refer to href="/OSCAL" and not href="https://pages.nist.gov/OSCAL" in error or to simplify link gen and lookup. Now that we are remapping the full URLs to local paths and offsets for link-checking, we want these to be consistent across the board in Metaschema after #1263. * Pushing generated website pages manual override [ci skip]. * Restore rel paths for develop branch ref model docs and fix link checks. * Test full URLs per @dave-waltermire-nist's PR feedback.
…anch (usnistgov#1518) * Fix documentation relative paths in Metaschema Recently added links in documentation refer to href="/OSCAL" and not href="https://pages.nist.gov/OSCAL" in error or to simplify link gen and lookup. Now that we are remapping the full URLs to local paths and offsets for link-checking, we want these to be consistent across the board in Metaschema after usnistgov#1263. * Pushing generated website pages manual override [ci skip]. * Restore rel paths for develop branch ref model docs and fix link checks. * Test full URLs per @dave-waltermire-nist's PR feedback.
…anch (usnistgov#1518) * Fix documentation relative paths in Metaschema Recently added links in documentation refer to href="/OSCAL" and not href="https://pages.nist.gov/OSCAL" in error or to simplify link gen and lookup. Now that we are remapping the full URLs to local paths and offsets for link-checking, we want these to be consistent across the board in Metaschema after usnistgov#1263. * Pushing generated website pages manual override [ci skip]. * Restore rel paths for develop branch ref model docs and fix link checks. * Test full URLs per @dave-waltermire-nist's PR feedback.
…anch (usnistgov#1518) * Fix documentation relative paths in Metaschema Recently added links in documentation refer to href="/OSCAL" and not href="https://pages.nist.gov/OSCAL" in error or to simplify link gen and lookup. Now that we are remapping the full URLs to local paths and offsets for link-checking, we want these to be consistent across the board in Metaschema after usnistgov#1263. * Pushing generated website pages manual override [ci skip]. * Restore rel paths for develop branch ref model docs and fix link checks. * Test full URLs per @dave-waltermire-nist's PR feedback.
…anch (usnistgov#1518) * Fix documentation relative paths in Metaschema Recently added links in documentation refer to href="/OSCAL" and not href="https://pages.nist.gov/OSCAL" in error or to simplify link gen and lookup. Now that we are remapping the full URLs to local paths and offsets for link-checking, we want these to be consistent across the board in Metaschema after usnistgov#1263. * Pushing generated website pages manual override [ci skip]. * Restore rel paths for develop branch ref model docs and fix link checks. * Test full URLs per @dave-waltermire-nist's PR feedback.
…anch (usnistgov#1518) * Fix documentation relative paths in Metaschema Recently added links in documentation refer to href="/OSCAL" and not href="https://pages.nist.gov/OSCAL" in error or to simplify link gen and lookup. Now that we are remapping the full URLs to local paths and offsets for link-checking, we want these to be consistent across the board in Metaschema after usnistgov#1263. * Pushing generated website pages manual override [ci skip]. * Restore rel paths for develop branch ref model docs and fix link checks. * Test full URLs per @dave-waltermire-nist's PR feedback.
Committer Notes
This PR should fix failures on various PRs pointed to develop branch that are failing after the merge of #1263. It should fix website link checking on the following PRs:
All Submissions:
"?
By submitting a pull request, you are agreeing to provide this contribution under the CC0 1.0 Universal public domain dedication.
Changes to Core Features:
Have you added an explanation of what your changes do and why you'd like us to include them?Have you written new tests for your core changes, as applicable?Have you included examples of how to use your new feature(s)?Have you updated all OSCAL website and readme documentation affected by the changes you made? Changes to the OSCAL website can be made in the docs/content directory of your branch.