Make it easy to run locally
February 21, 2020 ยท View on GitHub
- Write the docs
- Test it with users
- Make is system agnostic
- Provide a container system (Docker)
Quickstart info
- Enables users to quickly get started with the core functionality of the repo/project/community
- Often prioritizes the first key action
- Can also provide an optional way to learn more or ask for help
Quickstart examples WP-CLI includes the following sections in their quickstart info:
- Introduction
- Common Terms
- Practical Examples
Jekyll includes the following steps for their quickstart (with appropriate links and commands):
- Install a full Ruby development environment
- Install Jekyll and bundler gems
- Create a new Jekyll site at ./myblog
- Change into your new directory
- Build the site and make it available on a local server
- Now browse to http://localhost:4000
Quickstart information/resources
- (https://anthemopensource.atlassian.net/wiki/spaces/OSS/pages/157024674/Quickstart+Guide)
- (https://opensource.com/sites/default/files/gated-content/ansible_automation_for_sysadmins_v2.pdf)
- (https://docs.confluent.io/current/quickstart/ce-quickstart.html#ce-quickstart)
- (https://github.com/puppetlabs/docs-archive/blob/master/puppet/4.3/quick_start.markdown)
- (https://docs.konghq.com/1.1.x/getting-started/quickstart/)
- (https://duraspace.org/dspace/download/quickstart-guide/)
Not quickstart specific, but still helpful set-up instructions
- (https://openanthem.github.io/nimbus-docs/latest/quick-reference.html)
- (https://openanthem.github.io/nimbus-docs/latest/setup.html)
System Agnostic - means it'll run on any computer operating system such as Linux, Unix, Windows, Mac, etc. For example, Acrobat Reader. It is generalized so that it is interoperable among various systems. It can refer to software and hardware, and also business processes or practices.
How do we get our documentation to be system agnostic?