Serve only docs from /docs for embedding in new website #341
Conversation
This is a copy of the build output from #341 for testing embedding this into the new micrometer-website build.
shakuzen
force-pushed
the
archive-old-docs
branch
2 times, most recently
from
1a20e56 to
5b1ce8a
Compare
shakuzen
force-pushed
the
archive-old-docs
branch
2 times, most recently
from
0860caf to
4870a43
Compare
|
Should we merge this and use |
Either way works. I definitely didn't want to merge until we launched the new website and were sure we wouldn't need to rollback to this site. I think we're past that point, so we could merge. |
|
I've unpublished the GH Pages website from this repo since after merging this it won't be in a state meant to be served on its own. |
We want these docs to be available at the same web address as they have been, so we do not break links on the internet to our docs. However, we are planning to launch a new website with a different build from a different source repository. Rather than bring the legacy of this source and build, we want to try embedding the built static website from here into the new website. We should clearly indicate to visitors of the old docs that these are archived and will not be updated. We can link to the new docs so when users arrive from old links they know how to get to the new docs.
We do not want to stay in the React app for the archived docs. This allows loading the top page again whereas before you would end up at a blank page with the header and footer of the archived docs.
Prominently display a sticky warning at the top of the page to encourage people to go to the new docs and update their links.
As this site will be embedded into the other, it won't be handling the routing for that path anymore.
Locally serving the website does not hit this, but when deployed to Cloudflare Pages, the embedded site's 404 page is being used. This should hopefully make things work as expected.
The old React app docs will be embedded in another react app, so care has to be taken to not navigate within the old react app when we want to go to the support page on the new website.
shakuzen
force-pushed
the
archive-old-docs
branch
from
4870a43 to
7eb6045
Compare
|
Once the build updates the |
We want these docs to be available at the same web address as they have been, so we do not break links on the internet to our docs. However, we are planning to launch a new website with a different build from a different source repository. Rather than bring the legacy of this source and build, we want to try embedding the built static website from here into the new website.
We should clearly indicate to visitors of the old docs that these are archived and will not be updated. We can link to the new docs so when users arrive from old links they know how to get to the new docs.
TODO:
/docsSPATODO in new website code: redirect requests under the/docs/**path to the docs app with client-side routing. We can probably reuse this hack that's currently in theindex.htmlhere.