Update Development Guide wiki
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 3
- Forks
- 2
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 2
Description
This wiki page found here is intended to help developers by having additional information not found in the README or Product/User Guides. The following are suggestions for useful info that could be added to that wiki page. Note that each bullet point is relevant explanation to the checklist item right above the bullet.
-
Instructions on how to add user-specified ADMs per Linko's recent addition.
-
This would probably be a volume snippet to add to the docker-compose.yml. It's on my TODO list to test this with the COR setup
-
Information on updating port numbers in the .env file
-
Optional/Future: Potential to move certain services out of docker onto other systems (ie: a dedicated DB server)
-
How to set ANMS version number in UI if not set automatically.
-
Potential future enhancement to consider: the ability to edit UI header (e.g., add project name/logo/version)
-
Grafana - How to customize the default dashboard in the Monitor page, or add additional dashboards to deployment
-
This may be a mix of some quick anms-specfic instructions and link to grafana docs. Iirc, the way we have it deployed, customizing is supposed to become easier with the next grafana release
-
Maybe: Instructions on adding project-specific links to the UI Help page. (This is likely to change as UI is upgraded away from vue2)
-
Usage of dtnma proxy to connect with existing network.
-
This would likely be a link to any dtnma-tools docs and the example proxy app (and reference to our testenv example)
-
Reference (may point to other doc pages) on relevant implemented spec version supported
-
Proxy customization (based on the default 'demo' configuration)
-
Authentication: a quick reference to where to look to customize credentials
-
SSL Certificate: (users will likely want to register an SSL certificate trusted on their network)
-
Alternatively, pointer at required settings if user deploys ANMS behind an external proxy server
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Development-Guide wiki page and compare it with the README, Product/User Guides, docker-compose.yml, and .env. Review the existing Grafana and dtnma-tools/testenv references before documenting the requested deployment and customization topics. Done means the guide covers the selected checklist items with accurate project-specific instructions and links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker-compose, grafana, javascript
- Domain
- devops, documentation, observability
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100