NatLabRockies / NatLabRockies/api-umbrella
Installation documentation
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 2.2k
- Forks
- 373
- PR merge metrics
- No merged PRs in 30d
Description
As a server administrator
I would like brief installation instructions
So that I can prepare a server and install API Umbrella
Details
While we have great packaging and a Deploying from Git page, we do not have a specific page for Installing. An Installing page is somewhat conventional for project documentation, and is often included, for example, as INSTALL.txt.
Task
Lets put together a brief installation document for the Documentation section.
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
Review the existing packaging page and the Deploying from Git page linked in the issue, then inspect the Documentation section to find the appropriate location for a new Installing page. Keep the instructions brief and cover preparing a server and installing API Umbrella; confirm the result fits the project’s existing documentation structure.
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
- 42/100