Skip to content
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.

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

docs: Contributor Guide on the Website #4514

Merged
merged 8 commits into from
May 9, 2024

Conversation

elft3r
Copy link
Contributor

@elft3r elft3r commented May 7, 2024

what

This is an initial version of a contributor guide on the website. It contains, for now, an explanation of how the /events Controller 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.md file already exists, but I think we need another place for more in-depth information.

Best,
Jochen

@elft3r elft3r requested review from a team as code owners May 7, 2024 15:46
@elft3r elft3r requested review from chenrui333, lukemassa and X-Guardian and removed request for a team May 7, 2024 15:46
@github-actions github-actions bot added docs Documentation website labels May 7, 2024
Copy link
Member

@chenrui333 chenrui333 left a comment

Choose a reason for hiding this comment

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

thanks for doing this, left couple of comments. 👍

@elft3r elft3r force-pushed the jz/add-contributor-guide branch from 772aff1 to d00d246 Compare May 8, 2024 17:12
@elft3r
Copy link
Contributor Author

elft3r commented May 8, 2024

Thanks for the comments @chenrui333. I pushed changes for them. Let me know if I can further improve the documentation.

chenrui333
chenrui333 previously approved these changes May 9, 2024
Copy link
Member

@chenrui333 chenrui333 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

Signed-off-by: Rui Chen <[email protected]>
Signed-off-by: Rui Chen <[email protected]>
@chenrui333
Copy link
Member

image
image

@chenrui333 chenrui333 merged commit cc6c1fc into runatlantis:main May 9, 2024
24 checks passed
@chenrui333
Copy link
Member

@elft3r thanks for your first contribution to atlantis!

@elft3r
Copy link
Contributor Author

elft3r commented May 10, 2024

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 🤞

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants