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: Improves the frontend documentation on announcements #1921

Merged

Conversation

xfiderek
Copy link
Contributor

@xfiderek xfiderek commented Jul 2, 2022

Summary of Changes

  • Added default value for announcements.enabled to custom config to increase verbosity
  • Fixed wrong object name (typo) in the documentation
  • Added information about config-default.ts file to docs
  • Added information about announcement_client.md README

Tests

I've checked that announcements are disabled when the variable added to custom-config.ts is set to false and that setting it to true enables the feature. No new automated tests are needed IMO.

Documentation

Described above

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.

@boring-cyborg
Copy link

boring-cyborg bot commented Jul 2, 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)

xfiderek added 2 commits July 2, 2022 14:09
Signed-off-by: xfiderek <fiderekblazej@gmail.com>
Signed-off-by: xfiderek <fiderekblazej@gmail.com>
@xfiderek xfiderek force-pushed the fix-announcements-frontend-docs branch from 74f9e10 to bedcfb6 Compare July 2, 2022 12:10
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

@xfiderek
Copy link
Contributor Author

xfiderek commented Jul 3, 2022

@Golodhros could you merge it or do we need a second approval? I have insufficient permissions to merge.

@Golodhros Golodhros merged commit c723dd4 into amundsen-io:main Jul 3, 2022
@boring-cyborg
Copy link

boring-cyborg bot commented Jul 3, 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
Labels
area:frontend From the Frontend folder
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants