docs: Contributor Guide on the Website #4514
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
elft3r
requested review from
chenrui333,
lukemassa and
X-Guardian
and removed request for
a team
chenrui333
reviewed
May 7, 2024
chenrui333
reviewed
May 7, 2024
chenrui333
reviewed
May 7, 2024
elft3r
force-pushed
the
jz/add-contributor-guide
branch
from
772aff1
to
d00d246
Compare
|
Thanks for the comments @chenrui333. I pushed changes for them. Let me know if I can further improve the documentation. |
Signed-off-by: Rui Chen <[email protected]>
Signed-off-by: Rui Chen <[email protected]>
Signed-off-by: Rui Chen <[email protected]>
Signed-off-by: Rui Chen <[email protected]>
chenrui333
approved these changes
May 9, 2024
|
|
|
@elft3r thanks for your first contribution to atlantis! |
|
Thanks @chenrui333 for your support and getting this PR merged. Happy to help and hope that this is the first of many PRs from me 🤞 |
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
what
This is an initial version of a contributor guide on the website. It contains, for now, an explanation of how the
/eventsController works and a basic Glossary page.why
As part of working on #4448, I need to dig deep into Atlantis's inner workings. As there was no documentation about this available, I came up with the idea of starting it.
It's the first version that is open for discussion. I'd like to know if this is the best place for something like this or if you think another place is more suitable.
I know the
CONTRIBUTING.mdfile already exists, but I think we need another place for more in-depth information.Best,
Jochen