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.

Sign up for GitHub

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

Jump to bottom

Consolidated documentation portal docs.itk.org #4063

Open
1 of 35 tasks
jcfr opened this issue Jun 2, 2023 · 2 comments
Open
1 of 35 tasks

Consolidated documentation portal docs.itk.org #4063

jcfr opened this issue Jun 2, 2023 · 2 comments
Labels
type:Documentation Documentation improvement or change
Milestone
ITK 6.0.0

Comments

@jcfr
Copy link
Contributor

jcfr commented Jun 2, 2023 •
edited by thewtex
Loading

Description

This issue was created following discussion with @thewtex and @jadh4v.

It discusses the contents for a Sphinx-based website, published on the ReadTheDocs platform at
https://docs.itk.org

Associated markdown and configuration would be organized in the folder Documentation/docs

Expected information

Table of content:

Additional Information

References:

Related issues:
@jcfr jcfr added the type:Documentation Documentation improvement or change label Jun 2, 2023
@thewtex thewtex changed the title Consolidated documentaiton portal docs.itk.org Consolidated documentation portal docs.itk.org Jun 23, 2023
@thewtex thewtex added this to the ITK 6.0.0 milestone Sep 6, 2023
thewtex added a commit to thewtex/ITK that referenced this issue Oct 6, 2023
@thewtex
DOC: Add Sphinx Documentation rendering
36e4256 
This adds Myst (markdown) Sphinx documentation. This is to be rendered on
ReadTheDocs and deployed on docs.itk.org. A start for issue InsightSoftwareConsortium#4063.
Changes and more content are expected in the future! In particular, the
old wiki content, Software Guide content, and Tutorial. It
uses the clean and elegant Furo theme, which works with Myst and is also
used by docs.vtk.org and wasm.itk.org.

This incorporates the markdown files in the Documentation/ directory. It
renders a clean build without warnings. A few changes were required for
to avoid warknings, e.g. header specifications and cross-link
specifications.

Symlinks were created at the top level for CODE_OF_CONDUCT.md and
CONTRIBUTING.md, but these should be replace by real files with links to
the rendered content once published for GitHub access.
@thewtex thewtex mentioned this issue Oct 6, 2023
Merged
thewtex added a commit to thewtex/ITK that referenced this issue Oct 8, 2023
@thewtex @jcfr
DOC: Add Sphinx Documentation rendering
a7a92d4 
This adds Myst (markdown) Sphinx documentation. This is to be rendered on
ReadTheDocs and deployed on docs.itk.org. A start for issue InsightSoftwareConsortium#4063.
Changes and more content are expected in the future! In particular, the
old wiki content, Software Guide content, and Tutorial. It
uses the clean and elegant Furo theme, which works with Myst and is also
used by docs.vtk.org and wasm.itk.org.

This incorporates the markdown files in the Documentation/ directory. It
renders a clean build without warnings. A few changes were required for
to avoid warknings, e.g. header specifications and cross-link
specifications.

Symlinks were created at the top level for CODE_OF_CONDUCT.md and
CONTRIBUTING.md, but these should be replace by real files with links to
the rendered content once published for GitHub access.

Co-authored-by: Jean-Christophe Fillion-Robin <jchris.fillionr@kitware.com>
thewtex added a commit to thewtex/ITK that referenced this issue Oct 8, 2023
@thewtex @jcfr
DOC: Add Sphinx Documentation rendering
eb0aa52 
This adds Myst (markdown) Sphinx documentation. This is to be rendered on
ReadTheDocs and deployed on docs.itk.org. A start for issue InsightSoftwareConsortium#4063.
Changes and more content are expected in the future! In particular, the
old wiki content, Software Guide content, and Tutorial. It
uses the clean and elegant Furo theme, which works with Myst and is also
used by docs.vtk.org and wasm.itk.org.

This incorporates the markdown files in the Documentation/ directory. It
renders a clean build without warnings. A few changes were required for
to avoid warknings, e.g. header specifications and cross-link
specifications.

Symlinks were created at the top level for CODE_OF_CONDUCT.md and
CONTRIBUTING.md, but these should be replace by real files with links to
the rendered content once published for GitHub access.

Co-authored-by: Jean-Christophe Fillion-Robin <jchris.fillionr@kitware.com>
thewtex added a commit to thewtex/ITK that referenced this issue Oct 8, 2023
@thewtex @jcfr
DOC: Add Sphinx Documentation rendering
effb802 
This adds Myst (markdown) Sphinx documentation. This is to be rendered on
ReadTheDocs and deployed on docs.itk.org. A start for issue InsightSoftwareConsortium#4063.
Changes and more content are expected in the future! In particular, the
old wiki content, Software Guide content, and Tutorial. It
uses the clean and elegant Furo theme, which works with Myst and is also
used by docs.vtk.org and wasm.itk.org.

This incorporates the markdown files in the Documentation/ directory. It
renders a clean build without warnings. A few changes were required for
to avoid warknings, e.g. header specifications and cross-link
specifications.

Symlinks were created at the top level for CODE_OF_CONDUCT.md and
CONTRIBUTING.md, but these should be replace by real files with links to
the rendered content once published for GitHub access.

Co-authored-by: Jean-Christophe Fillion-Robin <jchris.fillionr@kitware.com>
@thewtex thewtex modified the milestones: ITK 6.0.0, ITK 5.4.0 Nov 8, 2023
@thewtex thewtex mentioned this issue Nov 9, 2023
Merged
2 tasks
@jhlegarreta
Copy link
Member

All shared links (e.g. SimpletITK, itk-wasm, etc.) should be put to a single document, and be included across all other Markdown files to ease maintenance.

@jhlegarreta
Copy link
Member

Maybe we should already mark as deprecated those wiki pages that have been transferred and put a link to the new site so that

  • users become increasingly aware of the new doc site,
  • we void confusion,
  • we have a better picture of what is left, and
  • the community, including ourselves, has a clear evidence that the transition work is actually happening.

@thewtex thewtex modified the milestones: ITK 5.4.0, ITK 6.0.0 May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type:Documentation Documentation improvement or change
Projects
None yet
Milestone
ITK 6.0.0
Development

No branches or pull requests
3 participants
@thewtex @jcfr @jhlegarreta