bitwalker / bitwalker/distillery

Improve Documentation

Open
#441 13 comments 1 reaction 0 assignees View on GitHub
discussion:rfc documentation documentation:guides help-wanted
Dominant language
Elixir
Stars
3k
Forks
398
PR merge metrics
No merged PRs in 30d

Description

This issue is to track the work for improving the documentation:

- [x] Split up guides/pages on topics to provide softer introductions with specific pages for more detailed content
- [ ] Provide intro page with basic rationale of releases, terminology, and starting points for different languages (i.e. I'm coming from Ruby or Python, here is how OTP releases compare).
- [ ] Provide doc to provide guidance on operations, troubleshooting, third-party tools
- [x] Provide "deploying with Docker" guide
- [x] Provide "deploying to Digital Ocean" guide (or anything which is just deploying to a VM)
- [x] Provide "deploying to AWS" guide
- [ ] Need documentation for Windows (HELP WANTED)

I'm open to suggestions for other guides/topics we should cover or address. I would prefer if you check with me first before opening PRs for documentation, as I'm going to be doing a lot of moving around and rewriting up front, and I would hate to conflict with anything you may want to help contribute. If we talk it out first, I can make sure we don't step on each others toes :)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.