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

Broken images in application_config documentation #2142

Open
ranggakd opened this issue Apr 18, 2023 · 6 comments
Open

Broken images in application_config documentation #2142

ranggakd opened this issue Apr 18, 2023 · 6 comments
Labels
status:needs_triage For all issues that need to be processed type:bug An unexpected problem or unintended behavior

Comments

@ranggakd
Copy link

Expected Behavior

Show the images on that page since I check out the frontend repo they are there.
https://github.com/amundsen-io/amundsen/tree/main/frontend/docs/img

Current Behavior

Showed broken image logos all over.
broken image logo

Possible Solution

I suggest fixing and updating the docs front end (Material for Mkdocs) as far as I know image links are already there.
image

Steps to Reproduce

  1. Visit this Amundsen documentation page
  2. Navigate to the specific section or page with broken images i.e. Announcements section
  3. Observe the broken images and check the browser console for error messages

Screenshots (if appropriate)

announcement section broken image

Context

Probably there are a bunch of broken image links in the docs and it can affect readability and it is hard to understand for people looking for complete documentation for something.

Your Environment

  • Amunsen version used:
  • Data warehouse stores:
  • Deployment (k8s or native):
  • Link to your fork or repository:
@ranggakd ranggakd added status:needs_triage For all issues that need to be processed type:bug An unexpected problem or unintended behavior labels Apr 18, 2023
@boring-cyborg
Copy link

boring-cyborg bot commented Apr 18, 2023

Thanks for opening your first issue here!

@stale
Copy link

stale bot commented May 3, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@stale stale bot added the stale label May 3, 2023
@stale
Copy link

stale bot commented Jun 10, 2023

This issue has been automatically closed for inactivity. If you still wish to make these changes, please open a new pull request or reopen this one.

@stale stale bot closed this as completed Jun 10, 2023
@Golodhros Golodhros reopened this Jul 7, 2023
@stale stale bot removed the stale label Jul 7, 2023
@Golodhros Golodhros added stale and removed stale labels Jul 7, 2023
@ranggakd
Copy link
Author

ranggakd commented Jul 8, 2023

I wish I could have done more and made a pull request to solve it but I'm pretty new with these docs. Is there anything I could help with? I believe these docs is crucial for developers and newcomers.

@stale
Copy link

stale bot commented Aug 7, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@stale stale bot added the stale label Aug 7, 2023
@ranggakd
Copy link
Author

ranggakd commented Nov 4, 2023

I believe documentation still plays a huge role in introducing this to new developers @Golodhros

@stale stale bot removed the stale label Nov 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:needs_triage For all issues that need to be processed type:bug An unexpected problem or unintended behavior
Projects
None yet
Development

No branches or pull requests

2 participants