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.

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

Jump to bottom

Doc enhancements #177

Merged
merged 20 commits into from
Dec 9, 2024
Merged

Doc enhancements #177

merged 20 commits into from
Dec 9, 2024

Conversation

yanmastin-astro
Copy link
Collaborator

Description

  • Add branding and link to docs in readme.md
  • Separate terrform user and developer content into readme.md and contributing.md

🎟 Issue(s)

https://github.com/astronomer/docs/issues/4384

🧪 Functional Testing

Manual review

@yanmastin-astro yanmastin-astro requested review from vandyliu and a team as code owners November 25, 2024 20:27
ichung08
ichung08 reviewed Nov 26, 2024
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
ichung08
ichung08 reviewed Nov 26, 2024
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
ichung08
ichung08 reviewed Nov 28, 2024
View reviewed changes
Copy link
Collaborator

@ichung08 ichung08 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 addressing all changes! docs look better but readme section looks more empty than before, is there anything else we can add to the front page?

yanmastin-astro
yanmastin-astro commented Dec 2, 2024
View reviewed changes
Copy link
Collaborator Author

@yanmastin-astro yanmastin-astro left a comment

Choose a reason for hiding this comment

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

Icon on White

vandyliu
vandyliu reviewed Dec 3, 2024
View reviewed changes
README.md Show resolved Hide resolved
vandyliu
vandyliu approved these changes Dec 3, 2024
View reviewed changes
Copy link
Collaborator

@vandyliu vandyliu left a comment

Choose a reason for hiding this comment

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

LGTM

@yanmastin-astro yanmastin-astro merged commit c781538 into main Dec 9, 2024
9 checks passed
@yanmastin-astro yanmastin-astro deleted the docs-refactor branch December 9, 2024 22:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vandyliu vandyliu vandyliu approved these changes

@ichung08 ichung08 Awaiting requested review from ichung08

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@yanmastin-astro @vandyliu @ichung08 @BasPH