Skip to content

docs: Edit docs for clarity and fix typos #2064

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
Merged
merged 1 commit into from
Dec 19, 2022
Merged

docs: Edit docs for clarity and fix typos #2064

merged 1 commit into from
Dec 19, 2022

Conversation

Mich45
Copy link
Contributor

@Mich45 Mich45 commented Dec 18, 2022

Documentation

This PR improves the Installation Guide for clarity and fixed some typos.

CheckList

Make sure you have checked all steps below to ensure a timely review.

  • PR title addresses the issue accurately and concisely. Example: "Updates the version of Flask to v1.0.2"
  • PR includes a summary of changes.
  • PR adds unit tests, updates existing unit tests, OR documents why no test additions or modifications are needed.
  • In case of new functionality, my PR adds documentation that describes how to use it.
    • All the public functions and the classes in the PR contain docstrings that explain what it does

@Mich45 Mich45 requested a review from a team as a code owner December 18, 2022 02:08
@boring-cyborg
Copy link

boring-cyborg bot commented Dec 18, 2022

Congratulations on your first Pull Request and welcome to Amundsen community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/amundsen-io/amundsen/blob/main/CONTRIBUTING.md)

Golodhros
Golodhros approved these changes Dec 19, 2022
View reviewed changes
Copy link
Member

@Golodhros Golodhros left a comment

Choose a reason for hiding this comment

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

LGTM

@Golodhros
Copy link
Member

@all-contributors please add @Mich45 for doc

@allcontributors allcontributors bot mentioned this pull request Dec 19, 2022
Closed
@allcontributors
Copy link
Contributor

@Golodhros

I've put up a pull request to add @Mich45! 🎉

@amundsen-io amundsen-io deleted a comment from allcontributors bot Dec 19, 2022
@Mich45
Copy link
Contributor Author

Mich45 commented Dec 19, 2022

Hi @Golodhros, I have signed the commits now.

@Golodhros Golodhros merged commit 5f8a404 into amundsen-io:main Dec 19, 2022
@boring-cyborg
Copy link

boring-cyborg bot commented Dec 19, 2022

Awesome work, congrats on your first merged pull request!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Golodhros Golodhros Golodhros approved these changes

Assignees
No one assigned
Labels
area:docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Mich45 @Golodhros