openresty / openresty/docker-openresty

Revamp documentation

Open
#216 0 comments 0 reactions 1 assignee View on GitHub

@neomantra is already working on this.

Since Oct 27, 2022.

documentation
Dominant language
Dockerfile
Stars
1k
Forks
536
Avg merge
1d 32m
Merged PRs (30d)
1

Description

The README.md has really sprawled and is more focused on building images than using them.

  • put building into its own Markdown doc, linked from the main README

  • add a simple example of bind-mounting default.conf (see #215)

  • breakout outdated caveats / comments into their own section

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.