silverstripe / silverstripe/developer-docs

Nginx configuration docs are empty

Open
#15 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

affects/v4 impact/medium type/bug type/docs
Dominant language
No language data
Stars
7
Forks
74
Avg merge
1d 14m
Merged PRs (30d)
6

Description

Visiting the page https://docs.silverstripe.org/en/3/getting_started/installation/how_to/configure_nginx/ shows an empty section where the example Nginx config should be. It seems to have been removed in a commit that formatted the docs for Gatsby: https://github.com/silverstripe/silverstripe-framework/commit/54e7223d981eee7f00244ad9a79187ee3f2f063a#diff-4bd44d58dc18b09f7a067b216a5f0916aa1a73ac93e51f3313ee0c9ae6465014L23

Along with several other code blocks that are examples. They should be probably all be added back in.

Contributor guide

Open the contributing guide

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.

Research direction

Open the linked configure_nginx documentation page and inspect the referenced Gatsby-formatting commit to identify the removed Nginx and other example code blocks. Restore the missing examples in the documentation source, then verify that the rendered page no longer has empty sections and displays the examples correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
nginx
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.