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

Some documentation issues for CI #374

Open
kahaaga opened this issue Jan 11, 2024 · 2 comments
Open

Some documentation issues for CI #374

kahaaga opened this issue Jan 11, 2024 · 2 comments
Labels
discussion-design Discussion or design matters documentation Improvements or additions to documentation

Comments

@kahaaga
Copy link
Member

kahaaga commented Jan 11, 2024

Issue 1

Previously, pushing a PR would trigger a documentation build preview that we could view at the url https://juliadynamics.github.io/DynamicalSystemsDocs.jl/complexitymeasures/previews/PRXXX/, where XXX is the PR number. This is no longer the case. For example, for PR #373, the documentation build is successful, but I can't access it at https://juliadynamics.github.io/DynamicalSystemsDocs.jl/complexitymeasures/previews/PR373/. I think this is because it is being deleted.

It is a bit cumbersome to have to build the docs locally to inspect them, so I think this behaviour should be as before: a successful doc build pushes a preview version of the documentation. We should still delete the preview, but only after the PR has been merged or closed.

Issue 2

All the old preview folders are not being deleted. There's currently tens of preview folders that still has some content. I guess we just manually delete these?

@kahaaga kahaaga added documentation Improvements or additions to documentation discussion-design Discussion or design matters labels Jan 11, 2024
@Datseris
Copy link
Member

Datseris commented Jan 11, 2024

the preview docs are only valid while the PR is open. YOu shouldn't expect to access them after the PR is merged. Is this issue existing while a PR is open?

All the old preview folders are not being deleted. There's currently tens of preview folders that still has some content. I guess we just manually delete these?

No, all of these should have been automatically deleted. I guess that's one more thing that broke in Documenter v1 that the devs didn't catch. Perhaps you can ask in the Julia #documentation slack channel?

@kahaaga
Copy link
Member Author

kahaaga commented Jan 11, 2024

YOu shouldn't expect to access them after the PR is merged

Yep, agreed.

Is this issue existing while a PR is open?

Yes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion-design Discussion or design matters documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants