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

Keep readme markdown and notebook in sync. #312

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

aslonnie
Copy link
Collaborator

@aslonnie aslonnie commented Sep 3, 2024

use relative asset links

Copy link
Contributor

@emmyscode emmyscode left a comment

Choose a reason for hiding this comment

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

How do we prevent the images from breaking in the console (when the images are edited on main, but still the same relative path in release branch/tag) and docs?

@aslonnie
Copy link
Collaborator Author

aslonnie commented Sep 3, 2024

How do we prevent the images from breaking in the console (when the images are edited on main, but still the same relative path in release branch/tag) and docs?

not sure if I understand the question correctly, but:

  • console are not referencing the main branch today?
  • asset urls are being replaced with loading the readme file
  • I do have a plan to embed all the images inline so that it won't worry about the assets/ directory.

@emmyscode
Copy link
Contributor

Never mind on the console concern. For docs, since we sync the templates READMEs in, we need to change this script https://github.com/anyscale/docs/blob/master/sync_oa_templates.py to switch from relative links for assets into absolute so that we can display images.

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.

2 participants