Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README needs update #1578

Open
HayenNico opened this issue Dec 19, 2024 · 0 comments
Open

README needs update #1578

HayenNico opened this issue Dec 19, 2024 · 0 comments
Labels
DCS DAPHNE Contribution to SciCat documentation Improvements or additions to documentation

Comments

@HayenNico
Copy link
Contributor

Summary

The README.md file should be updated to reflect the custom dataset types feature from PR #1532. Additionally, README should include required versions of node and npm to successfully run npm install.

Current Behaviour

  • Missing references to datasetTypes.json file
  • No mention of prerequisites for installation
  • Typo in "Proposal types configuration" section title

Expected Behaviour

  • Should include datasetTypes.json mounts as optional steps in "Get started" and "Develop in a container"
  • Should add new section "Dataset types configuration" with similar documentation as proposals
  • Should include required node/npm installation (node >= v20.x, npm >= v10.x) under "Getting started"

Details
@HayenNico HayenNico added documentation Improvements or additions to documentation DCS DAPHNE Contribution to SciCat labels Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
DCS DAPHNE Contribution to SciCat documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@HayenNico