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

fix image paths #901

Closed
wants to merge 2 commits into from
Closed

fix image paths #901

wants to merge 2 commits into from

Conversation

willtsai
Copy link
Contributor

@willtsai willtsai commented Oct 20, 2023

Thank you for helping make the Radius documentation better!

Please follow this checklist before submitting:

  • Read the contribution guide
  • Commands include options for Linux, MacOS, and Windows within codetabs
  • New file and folder names are globally unique
  • Page references use shortcodes instead of markdown or URL links
  • Images use HTML style and have alternative text
  • Places where multiple code/command options are given have codetabs

In addition, please fill out the following to help reviewers understand this pull request:

Description

Fixing path related issues for images not rendering when the docs webpage is accessed without a trailing /

Auto-generated description

🤖 Generated by Copilot at 8f77bab

Summary

🖼️🏠📚

This pull request restructures the docs content by moving some topics to the homepage and fixes the paths to many images by adding a ./ prefix. The purpose is to make the docs more user-friendly, accessible, and consistent.

The docs had some images to fix
With ./ prefixes to affix
They also moved pages
To suit different stages
And make the content easier to nix

Walkthrough

  • Move the content from various subpages to the homepage (docs/content/_index.md) as part of a restructuring of the docs content to simplify the navigation and organization of the topics (link, link, link, link, link)
  • Fix the paths to the images in the docs by adding a ./ prefix to ensure that they render correctly when the webpage is built (link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link)
  • Add a note and an example to the section on images in the contributing docs (docs/content/community/contributing/contributing-docs/index.md) to provide clear guidance and best practices for contributors who want to add images to the docs (link, link)

Issue reference

Fixes: #882

Signed-off-by: Will Tsai <[email protected]>
Signed-off-by: Will Tsai <[email protected]>
@willtsai willtsai requested review from a team as code owners October 20, 2023 17:30
@willtsai willtsai temporarily deployed to latest October 20, 2023 17:30 — with GitHub Actions Inactive
@willtsai willtsai temporarily deployed to latest October 20, 2023 17:32 — with GitHub Actions Inactive
@github-actions
Copy link

Azure Static Web Apps: Your stage site is ready! Visit it here: https://calm-bush-0cc2a4f1e-901.westus2.3.azurestaticapps.net

@willtsai
Copy link
Contributor Author

Abandoning this in favor of #886, which will actually solve this problem.

@willtsai willtsai closed this Oct 20, 2023
@willtsai willtsai temporarily deployed to latest October 20, 2023 17:39 — with GitHub Actions Inactive
@willtsai willtsai deleted the willtsai/fix-image-paths branch October 20, 2023 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Gettings started page does not load the image depicting the diagram of application and its resources
1 participant