Modernize legacy doc libs pages fetched directly from S3. #544
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
nessita
force-pushed
the
534-modernize-doc-libs-pages
branch
2 times, most recently
from
8889405
to
0abf133
Compare
nessita
force-pushed
the
534-modernize-doc-libs-pages
branch
from
8b8c92b
to
09ac86a
Compare
nessita
changed the title
nessita
force-pushed
the
534-modernize-doc-libs-pages
branch
from
09ac86a
to
02e74c4
Compare
This modernization occurs on the fly over potentially-cached S3 files. This means, the legacy doc pages are fetched and cached just like any other S3 static content, and the modernization happens when the page is requested. This way, we can safely render modern parts of the pages (like the header) and account for dynamic state such as logged in users. The resulting docs (also called FrankenDocs :-)) are processed using BeautifulSoup and a fairly simple heuristic that can be found in the `core/htmlhelper.py` module.
nessita
force-pushed
the
534-modernize-doc-libs-pages
branch
from
02e74c4
to
6d24b44
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This modernization occurs on the fly over potentially-cached S3 files. This
means, the legacy doc pages are fetched and cached just like any other S3
static content, and the modernization happens when the page is requested.
This way, we can safely render modern parts of the pages (like the header)
and account for dynamic state such as logged in users.
The resulting docs (also called FrankenDocs :-)) are processed using
BeautifulSoup and a fairly simple heuristic that can be found in the
core/htmlhelper.pymodule.Fixes #534.