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

11 harmonize the nexus web pages convert the current wiki to use sphinx same as the main nexus documentation #14

Draft
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

RussBerg
Copy link
Contributor

The old Vagrant based wiki files have been removed and replaced with a sphinx-build just like the standard nexus manual.
Closes #11

Using linkchecker I managed to resolve the internal links such that linkchecker does not report any issues but when I look at external links then there are a great many that have issues such as links to projects that used to exist when the markdown was edited, for example: Project on Github <https://github.com/nexusformat/NIAC/projects/3>__ etc.

Being that the current wiki contains these broken links it is perhaps not an issue?, it would take significant effort to go through everything to remove/fix all of the link problems.

This will need some discussion at an upcoming NIAC technical meeting but before then this PR needs to be reviewed as it likely needs a few iterations.

@RussBerg RussBerg marked this pull request as ready for review January 22, 2025 20:03
@RussBerg RussBerg marked this pull request as draft January 22, 2025 20:27
@PeterC-DLS
Copy link
Contributor

Some points:

  • build directory included
  • maybe leave the markdown and use a sphinx extension: https://www.sphinx-doc.org/en/master/usage/markdown.html - this will be a lot less churn
  • consider deploying a specific website github pages-only repo then we can also add the historical versions of the manual in the same place (need to check what domains are used and whether we need to redirect old domains to sub-directories)

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.

Harmonize the NeXus web pages, convert the current wiki to use sphinx same as the main NeXus documentation
2 participants