search

runatlantis / atlantis

Terraform Pull Request Automation
https://www.runatlantis.io
Other
7.83k stars 1.06k forks source link

Pull Request template is required, especially about documentation #2573

Open chroju opened 2 years ago

chroju commented 2 years ago

Community Note

Describe the user story

Many great features are continually being implemented in Atlantis. Unfortunately, many of these features are not documented. We often cannot solve problems in our own Atlantis without checking the commit log or closed PRs.

Describe the solution you'd like

Pull request template is required. Encourage contributors to describe their great features in the docs.

In addition, from my personal point of view, We should have a good troubleshooting page. This is because the added command line flags can often solve existing problems.

Describe the drawbacks of your solution

It may be difficult to make the formatting of documents standardized for all contributors.

However, some rules can be defined, such as making sure that new command line flags have to be always added to the server-configuration.md.

Describe alternatives you've considered

Nothing.

jamengual commented 2 years ago

2000+

On Sat, Oct 8, 2022, 4:21 a.m. chroju @.***> wrote:

Community Note

  • Please vote on this issue by adding a 👍 reaction https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/ to the original issue to help the community and maintainers prioritize this request. Searching for pre-existing feature requests helps us consolidate datapoints for identical requirements into a single place, thank you!
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment.

Describe the user story

Many great features are continually being implemented in Atlantis. Unfortunately, many of these features are not documented. We often cannot solve problems in our own Atlantis without checking the commit log or closed PRs.

For example, I have been helped to solve problems by these PRs, but none of them are documented (I just created PRs).

Describe the solution you'd like

Pull request template is required. Encourage contributors to describe their great features in the docs.

In addition, from my personal point of view, We should have a good troubleshooting page https://www.runatlantis.io/docs/troubleshooting-https.html. This is because the added command line flags can often solve existing problems.

Describe the drawbacks of your solution

It may be difficult to make the formatting of documents standardized for all contributors.

However, some rules can be defined, such as making sure that new command line flags have to be always added to the server-configuration.md.

Describe alternatives you've considered

Nothing.

— Reply to this email directly, view it on GitHub https://github.com/runatlantis/atlantis/issues/2573, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAQ3ERGAWJQ3UHNBL6U7B3LWCFKNBANCNFSM6AAAAAARAG5UCY . You are receiving this because you are subscribed to this thread.Message ID: @.***>