Coder Social home page Coder Social logo

Comments (5)

jordanpadams avatar jordanpadams commented on September 27, 2024

@jimmie specific documentation updates per convo with SBN:

  • in general, email instructions needs to be revised to be: As a user, I need to do what to make this thing work. details and technical jargon need to be revised since most people don't know (or care) about "load balancers" and "elastic search"
  • Change password - when having the node change their password, note they should not have to care about the Kibana screen at this time
  • Config - the Harvest and Registry Manager documentation pages should explicitly call out a Recommended Config that references an example that we want all the nodes to start with
  • In AWS QuickStart - note where to find default configs and what needs to be updated.
  • API Documentation? - where is it? there is no links in the registry docs about where to find API documentation and how to query the API after I have ingested data.

from pds-registry-app.

jimmie avatar jimmie commented on September 27, 2024

Adding this point from a recent interaction with SBN:

Apologies for the lack of clarity here. After running Harvest, you need to run registry manager to load the data you just “harvested” from the labels.

https://nasa-pds.github.io/pds-registry-app/operate/reg-manager.html#Load

We are working to combine these 2 tools, but for now they are 2 separate steps.

One unfortunate assumption we have in our docs is folks are starting with the “Test Your Deployment” part, which walks through the various steps. We kind of skipped that with the cloud info we provided. We will be updating our docs with a “Quick Start” procedure in the future that will hopefully make this much more clear.

from pds-registry-app.

tloubrieu-jpl avatar tloubrieu-jpl commented on September 27, 2024

pushed on a branch (fork of @tdddblog docs branch)

TBD for reference to the restful API doc

from pds-registry-app.

jimmie avatar jimmie commented on September 27, 2024

PR #35 created to merge into doc branch

from pds-registry-app.

jordanpadams avatar jordanpadams commented on September 27, 2024

awaiting review. see PR above

from pds-registry-app.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.