这是indexloc提供的服务,不要输入任何密码
Skip to content

Conversation

@josegonzalez
Copy link
Member

This is the beginning of my more or less complete overhaul of the documentation.

  • Adds some stylistic changes to make certain things look nicer/call attention to stuff like when a feature was released.
  • Adds sections that people often ask about, such as One off processes (Cron).
  • Moves documentation onto their own pages when the feature is big enough. Examples are dockerfile deploys, image tagging, and zero downtime deploys.
  • Expands sections that were lacking. The installation and getting started pages needed some work and they just got a lot of love.
  • Formatting. I love formatting.

Still needs a bit of work around the following topics:

  • Nginx/DNS: I may consolidate these.
  • Image tagging: Would be nice to make that page more tutorial-like.
  • Dockerfile deploys
  • Process scaling: It's a bit wonky, and I don't use it much. Anything I need to add here?
  • Needs a section on general logging.

Would love some thoughts on this. Our docs have been a bit sad, and the recent design changes make me want to write more lovely-looking documentation :)

Blockquote elements that call out a new feature are given a "pink" background, whereas all others are given a "blue" background. This is to help avoid cases where users expect a feature to work for their version when they are several versions behind when a feature was introduced.
- Move some docs to nginx and checks pages
- Flesh out dockerfiles and image tagging documentation a bit on their own pages
We never actually documented either the `enter` or `run` commands, nor did we have recommendations for running cron tasks.
Added documentation on little-known flags and also renamed the section "Environment Variables"
This is now documented in the one-off-processes section
josegonzalez added a commit that referenced this pull request Oct 16, 2015
@josegonzalez josegonzalez merged commit 5d1d034 into master Oct 16, 2015
@josegonzalez josegonzalez deleted the documentation-overhaul branch October 16, 2015 02:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants