Add NDP-EP documentation section for the central NDP docs site#184
Merged
Conversation
added 3 commits
June 1, 2026 04:33
Add the README index and the first draft page (00-what-is-an-endpoint.md) intended for inclusion in the central NDP documentation site under /documentation/ndp-ep/. Plain Markdown drop-ins, no site-specific front-matter. Refs #183
01-using-an-endpoint.md — researcher / educator path: arriving at an EP, CILogon institutional login, the Search interface, opening URL / S3 / Kafka resources, and what to do when they want to publish. 02-requesting-access-and-roles.md — the three role tiers and what they can do, the Request Access workflow, and how a new role takes effect on next sign-in. 03-publishing-data.md — the six '+ New' flows with a field cheat-sheet for each, a typical publishing flow, managing owned items on Search, the S3 Management tool, and when to switch to the Python library. 04-automating-with-python.md — installing ndp-ep, connecting with token or username/password, common operations (list/search/register dataset, URL/S3/ Kafka resources), S3 management from code, and typical use cases. 05-for-institutional-admins.md — when an institution needs an EP, the platform/institution responsibility split, how to obtain an Endpoint from the NDP team, what runs day to day, optional integrations (JupyterLab, Kafka, Pelican, NetBird) and operational notes. Refs #183
Endpoints are independent destinations reached directly at their URL. Datasets only appear in the central NDP catalog when a writer explicitly publishes them upstream through Pre-CKAN. The platform's federation registry knows EPs exist (via periodic status reports) but does not auto-aggregate their catalogs. Refs #183
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.
Summary
Adds a new
docs/info_for_nationaldataplatform/folder with six drop-in Markdown pages plus a README index, intended for inclusion in the central NDP documentation site (suggested path:/documentation/ndp-ep/...). The official NDP docs do not currently describe what an Endpoint is, how a user interacts with one, how to request access and publish data, how to automate with the Python client, or how an institution can obtain an EP and integrate it — this section fills that gap.Pages:
README.md— folder index, audiences and statuses.00-what-is-an-endpoint.md— what an NDP-EP is, where it fits, who needs one, what it is not.01-using-an-endpoint.md— researcher/educator view: reaching an EP, signing in via CILogon (institutional only), the Search experience, opening URL / S3 / Kafka resources.02-requesting-access-and-roles.md— the three role tiers (viewer / writer / admin) and the Request Access workflow.03-publishing-data.md— the six+ Newflows with a required/optional field cheat-sheet for each.04-automating-with-python.md— thendp-eplibrary (install, connect, common operations, S3 management from code, typical use cases).05-for-institutional-admins.md— when an institution needs an EP, the platform/institution responsibility split, how to obtain one, what runs day to day, optional integrations, operational notes.Test plan
Publishaction through Pre-CKAN; the federation registry tracks EP existence via periodic status reports but does not auto-aggregate catalogs.Closes #183