freedomofpress / freedomofpress/securedrop-dev-docs
Add list of sources added after make dev
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 4
- Avg merge
- 2h 22m
- Merged PRs (30d)
- 1
Description
I was setting up securedrop locally and noticed the docs missed the new sources being added. I also noticed it was also missing out on clarkkent as a journalist. Maybe we should add them in the docs too so that it is easier for user to know that there are already test sources as well. It can be missed out in logs.
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 by locating the developer setup documentation that explains make dev and review how test sources are described. Add the sources created after setup, including clarkkent as a journalist, so users can find the available test sources without relying on logs.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100