Skip to content

Update uploading and publishing data with the API tutorial GUI v2 Projects #376

Closed

Description

@ahm531

Update API uploading and publishing tutorial for NOMAD GUI 2

Page: /tutorial/upload_publish_api.md

Update the Uploading and publishing data with the API tutorial to align it with NOMAD GUI 2 and the new project-based workflow.

Required changes

  1. Update terminology

    • Replace references to uploads and datasets with projects where appropriate.
    • Review the text carefully rather than performing a direct terminology replacement, since some references to uploads may still be technically relevant at the API level.
  2. Verify the complete tutorial workflow

    • Follow the tutorial from beginning to end and ensure that all described steps and API operations work correctly with the current NOMAD version and NOMAD GUI 2.
    • Update instructions, examples, or descriptions where the workflow has changed.
  3. Revise "Introduction" and "What you will learn"

    • Remove or revise statements describing a workflow where entries are organized into datasets.
    • Reflect the current project-based workflow instead.
  4. Update "Before you begin"

    • Correct the link for creating/getting a NOMAD user account.
    • The relevant information is no longer located on the documentation overview page; it is now provided under the How-to guides.

General considerations

The updated tutorial should reflect the terminology and workflows intended for NOMAD 2.0. In particular, projects should be presented as the primary organizational unit rather than datasets.

While revising the page, please also flag any remaining concepts, links, API examples, or terminology that appear outdated and may require follow-up changes.

Activity

  1. JFRudzinski commented on Oct 1, 2026

    @JFRudzinski
    Contributor

    closed by #379

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions