Comments (5)
@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.
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.
pushed on a branch (fork of @tdddblog docs branch)
TBD for reference to the restful API doc
from pds-registry-app.
PR #35 created to merge into doc branch
from pds-registry-app.
awaiting review. see PR above
from pds-registry-app.
Related Issues (20)
- Develop design documentation for staging vs production data for review with SWG HOT 1
- As a developer, I want to update and run the integration tests from the 'registry' repository HOT 1
- the snapshot releases are not created for big-data-harvest-client HOT 5
- Tag new version of registry-common, registry-mgr, supplementer, harvest, and parent registry-app to resolve log4j vulnerability HOT 2
- Find the nicer way to initialize off-the-shelf system in microservice architecture HOT 7
- Rename bigdata repositories HOT 1
- pom.xml on main is broken HOT 1
- Simplify the readme and procedure to start the registry with docker-compose
- As an administrator, I want to use the same configuration file for the different big-data harvest components HOT 3
- Registry App docs need a scrub for inconsistency and outdated information HOT 2
- Update the README of the harvest service repositories HOT 1
- test registry docker compose with opensearch instead of elasticsearch HOT 4
- As a user, I want the registry loader tools to continue after the ingestion of a product fails
- use postman pre-test to wait for elasticsearch to be ready and populated before running integration tests
- Simple wrappers to call the pds-batch-loader and pds-service-loader docker compose services HOT 1
- Make CICD work on registry-api repository HOT 2
- have the replacePrefix configuration in the reference test in repository nasa-pds/registry HOT 1
- Possibility to filter-out secondary products for Harvest HOT 9
- Update the user documentation of the registry with the docker compose deployments HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pds-registry-app.