Skip to content

Docs contribution section #25374

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Docs contribution section #25374

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CONTRIBUTING.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,12 @@ Before we accept a non-trivial patch or pull request we will need you to https:/
Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do.
Active contributors might be asked to join the core team, and given the ability to merge pull requests.

== Documentation contributions

The documentation is stored in this repository, in the link:https://github.com/spring-projects/spring-boot/tree/master/spring-boot-project/spring-boot-docs/src/docs/asciidoc[spring-boot-docs] project.

You may use GitHub's built-in editor for Asciidoc by pressing the top-right Edit button to edit the documentation in browser.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure we should bother describing the various ways changes can be contributed on GitHub. As a matter of a fact, I prefer contributions that originate from "real branches" as it makes the follow-up easier. We expect contributors to build the documentation and check that the output is valid which you cant' do using the web editor.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aren't there automatic checks (doc build) on a PR request even when using the github's web editor?

Copy link
Member

@snicoll snicoll Mar 1, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A contributor is expected to validate their changes before submitting a PR and I am not keen to let contributors use our CI infrastructure to validate their changes.

Part of that is because if you keep this trial and error until you push something that works, you'd trigger a notification for each commit attempt to the 3K people watching this repository.

Having said that, I can see how simple documentation changes could be easily validated from your browser.

Alternatively, you can clone and change it in an editor of your choice on your machine.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure what that sentence brings to this section.


== Code Conventions and Housekeeping
None of these is essential for a pull request, but they will all help. They can also be
Expand Down