amundsen-io / amundsen

Amundsen is a metadata driven application for improving the productivity of data analysts, data scientists and engineers when interacting with data.
https://www.amundsen.io/amundsen/
Apache License 2.0
4.39k stars 954 forks source link

Broken images in `application_config` documentation #2142

Open ranggakd opened 1 year ago

ranggakd commented 1 year ago

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

boring-cyborg[bot] commented 1 year ago

Thanks for opening your first issue here!

stale[bot] commented 1 year ago

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[bot] commented 1 year ago

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.

ranggakd commented 1 year ago

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[bot] commented 1 year ago

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

ranggakd commented 10 months ago

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