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 doc preview in PR CI #389

Merged
merged 8 commits into from
Apr 10, 2024
Merged

Fix doc preview in PR CI #389

merged 8 commits into from
Apr 10, 2024

Conversation

lucyleeow
Copy link
Collaborator

@lucyleeow lucyleeow commented Apr 6, 2024

  • Update names downloading artifacts: we changed workflow name and build dir from 'docs' to 'html' -> this updates this and updates the images to match new names
  • Adds more info on difference between local vs PR preview and circle CI vs artifact download preview.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 6, 2024
@psobolewskiPhD
Copy link
Member

Wait, that's the contributing documentation guide, so for this repo.
In this repo, on PRs, we still have the action that make the artifact. I think it's useful to check it -- it's more of the ground truth than the CircleCI because in principle it's what gets deployed to gh-pages, same runners, same workflow now (since it was unified with all the consequences).
So I'm not sure I like totally deleting the info on downloading the artifact...

(That said on napari/napari it's just circleCI now, which is fine I think because most docs things will go through this repo.)

@lucyleeow
Copy link
Collaborator Author

No problem, we can document both. Still need to update the docs as we get to the artifact a different way now.

@psobolewskiPhD psobolewskiPhD added this to the 0.5.0 milestone Apr 6, 2024
@lucyleeow
Copy link
Collaborator Author

I've updated everything (since we updated the CIs things have changed names) - hopefully its okay, I'll come back and double check later!

@lucyleeow
Copy link
Collaborator Author

lucyleeow commented Apr 6, 2024

🤦 oh man I just realised that you could still download the artifact and the old docs described how to do both and were fine really.
Oh well updated names and added more info

Copy link
Member

@psobolewskiPhD psobolewskiPhD left a comment

Choose a reason for hiding this comment

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

Thanks for updating things!

docs/developers/contributing/documentation/index.md Outdated Show resolved Hide resolved
Copy link
Member

@melissawm melissawm left a comment

Choose a reason for hiding this comment

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

Looks great to me, thanks @lucyleeow !

@jni jni merged commit 5a3e18e into napari:main Apr 10, 2024
7 checks passed
@lucyleeow lucyleeow deleted the rendered_doc branch April 10, 2024 01:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants