docs(site): new landing page for ekalinin.github.io/nodeenv - #421
Merged
Merged
Conversation
Replace the 2013 generator page, a copy of the README at 0.6.5, with a single landing page in site/: install command, quick start, main features, node sources, a ~/.nodeenvrc sample and links into the README. The page restates README.rst only and states no nodeenv, node or npm version; the current release shows through the PyPI badge. It has no JavaScript and no analytics, and follows the system light or dark color scheme.
Upload site/ as is and deploy it with the official Pages actions on every master push that touches site/ or this workflow, and on manual dispatch. Requires the Pages source to be set to GitHub Actions.
This file contains hidden or 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
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.
What happens
ekalinin.github.io/nodeenv is still the page GitHub's automatic page generator produced in 2013 from the
gh-pagesbranch. It is a copy of the README at nodeenv 0.6.5: node v0.4.6,sudo easy_install, zip downloads of master, and a Universal Analytics tracker that stopped collecting in 2023. Nothing kept it in sync with the README, so it never moved.What changes
site/index.htmlandsite/style.css: a single landing page. It has the install command, a quick start with the Windows activate scripts, three feature cards, the prebuilt/mirror/system options, a~/.nodeenvrcsample, and links into the README for everything else..github/workflows/pages.yml: deployssite/as is with the official Pages actions. It runs on master pushes that touchsite/or the workflow, and on manual dispatch.After merge
The repository still serves Pages from the
gh-pagesbranch, so the run triggered by the merge fails until the source is switched:https://ekalinin.github.io/nodeenv/.gh-pagesbranch.Until step 4, setting the source back to the branch restores the old page.
Checked
actionlintpasses on the workflow, and the sdist built from this branch contains nosite/files.#usage,#command-line-optionsand#configurationexist, and every link on the page returns 200.