NASA-AMMOS / NASA-AMMOS/AIT-Core
Documentation package path naming inconsistencies
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 56
- Forks
- 35
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 3
Description
There's a few places in the documentation where server package paths are incorrectly listing old names. For example:
The Database API Page lists the data archive server plugin as being ait.core.server.plugin.DataArchive when it should be under plugins.
It seems like most (all?) of these inconsistencies are around the plugins for the server. Should double check our documentation and see if we missed an update when changing the server packing structure around.
Contributor guide
No contributing guide indexed for this repository
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 Database API Page at https://ait-core.readthedocs.io/en/master/databases.html and review documentation references to server plugins and package paths. Check whether paths such as ait.core.server.plugin.DataArchive should use the plugins structure, then verify that all documented server plugin paths match the current naming.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100