Add an install guide for the one-line script - #213
Merged
Conversation
added 2 commits
July 27, 2026 12:09
Walk through 'bash <(curl -fsSL https://bit.ly/ndp-ep)': prerequisites, registering with the Federation, and each catalog option (MongoDB installed or existing, CKAN installed or existing) plus the optional features, each with a placeholder for a screen recording. Link it from the README Quick Start so the script route is the first thing an operator sees, with the manual Docker setup kept for development. Refs #212
The guide described the installer as it was on 27 July. Since then the catalog question gained a fifth answer — no local catalog, now the first and the default — and the identity-provider sign-in question was removed, because no client an Endpoint can use exists yet. Documenting a prompt that is not there sends people looking for it, so the five options are listed with 'None' first, the sign-in mentions are gone from the prerequisites, the walk-through and the after-installing section, and the standalone no-catalog sequence diagram is linked from the end. Version renumbered from 0.33.6 to 0.34.4, two releases having shipped while this sat open.
rbardaji
force-pushed
the
docs/install-script-guide
branch
from
August 4, 2026 10:41
5f9c1b4 to
8b53e97
Compare
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
1 participant
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.
Closes #212
Adds an operator-facing guide for installing an Endpoint with the script — the way we actually do it now — and links it from the README Quick Start.
What's in it
docs/installing-with-the-script.md:
bash <(curl -fsSL https://bit.ly/ndp-ep), with a note to use the<(...)form so prompts stay interactive.📹 Recording: coming soon).The README Quick Start now leads with the script and keeps the manual Docker setup for development.
Docs only — no code changes.