spring-projects / spring-projects/spring-security

Add a "how to contribute to docs section" to the docs

Open
#8,192 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

in: docs type: enhancement
Dominant language
Java
Stars
9.6k
Forks
6.3k
Avg merge
2d 11h
Merged PRs (30d)
52

Description

A person wishing to contribute to the documentation for example adding a small section, clarifying some content has to figure out how to contribute to the docs. an occasional contributor might have 1 hour to improve the docs, but it is not obvious how long it will take to configure a tool chain to effectively contribute docs. I suggest adding a section on how contribute to the docs into the docs so that more folks can get going making contributions. The section should cover the following topics.

  • How much time it will take to configure any environment to contribute to the docs. Ideally this can be 10 min or less to setup the env.
  • what technology is used to write the docs
  • steps for write, edit, view cycle on developer machine
  • Links to a tutorial on the tech used to write docs for example asciidoctor cheat sheet
  • recommendation for good editor plugins to make contributing to the docs easy

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

No file, test, or documentation entry point is named; first locate the existing documentation contribution guidance and determine the docs authoring toolchain. Add a contributor section covering setup time, authoring technology, the write/edit/view cycle, learning links, and editor plugins, with instructions clear enough for a one-hour contributor to follow.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.