This repository has been archived by the owner on Feb 18, 2024. It is now read-only.
Documentation cleanup #910
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file is shown on the front page of the docs, so doesn't need to link to itself.
To prevent the HTTP 301 redirect.
Since the page name in the URL is normalised to `/faq/` by Netlify, but yet the sidebar still links to `/FAQ/` (due to the filename), causing an unnecessary HTTP 301 redirect.
To avoid the HTTP 301 redirect.
Since the same README.md is shared between the NPM package listing and the generated docs, there doesn't seem to be a more elegant way to do it than this.
To avoid unnecessary HTTP 301s, since mkdocs uses `<name>/index.html` for all pages (unlike gitbook), which Netlify normalises to `/<name>/`.
To avoid the HTTP 301 redirects.
This will mean the image is served over Netlify's CDN. The link to neutrinojs.org has also been removed, since it's linking to itself.
14 tasks
eliperelman
reviewed
May 29, 2018
| # which have to use absolute URLs so that they work on the NPM package | ||
| # pages. This converts them to site-root relative URLs, so that links | ||
| # between packages target the current branch's version of the docs. | ||
| find build/ -type f -name '*.html' -exec sed -i 's|https://neutrinojs\.org/|/|g' {} + |
There was a problem hiding this comment.
If I'm reading this line right, this says:
Find all *.html files in the build folder and replace all occurrences of https://neutrinojs.org with a /. Is that right?
There was a problem hiding this comment.
Yeah but with the trailing slash on the original -- it converts https://neutrinojs.org/foo/bar/ to /foo/bar/.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
neutrino.js.orgURLs withneutrinojs.org(like [v8.x] Changes for neutrino.js.org to neutrinojs.org transition #903 did forrelease/v8).scripts/build-docs.shthat runsmkdocs buildfollowed by asedthat turns theneutrinojs.orginpackages/*/README.md(that are required so the READMEs work on NPM) into relative URLs that will point at the current branch's version of the docs.CNAMEfile.