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

Download page releases #4288

Merged

Conversation

thewtex
Copy link
Member

@thewtex thewtex commented Nov 6, 2023

Documentation improvements and updates for releases.

Add "Current release" and "Latest pre-release" sections. Add emoji's and
shorten titles for conciseness, clarity, and style. Add vcpkg to
"Package managers" section -- more package managers and the contents of
the referenced blog post could be added in the future.

Update download page cookiecutter markdown for future release notes and
download page content. We now direct to the sphinx download page so
remove the Wordpress HTML output.
Section-level cross-references across documents are not supported in
Myst.

Addresses:

```
/home/matt/src/ITK/Documentation/docs/contributing/code_of_conduct.md:358: WARNING: local id not found in doc 'contributing/motivation': 'diversity-statement' [myst.xref_missing]
```
Update to docs.itk.org link. Remove trailing RTD for en/latest on
Documentation. Remove "Help" link wwith preference towards
"Documentation". Move the homebrew link to the Download page package
managers section.
@github-actions github-actions bot added type:Infrastructure Infrastructure/ecosystem related changes, such as CMake or buildbots area:Python wrapping Python bindings for a class area:Documentation Issues affecting the Documentation module labels Nov 6, 2023
And use direct emoji's in current notes for rendering in Myst.
@thewtex thewtex force-pushed the download-page-releases branch from 89c66e3 to cd5dfad Compare November 6, 2023 15:30
@thewtex thewtex requested a review from jcfr November 6, 2023 15:37
Copy link
Contributor

@phcerdan phcerdan left a comment

Choose a reason for hiding this comment

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

🚀 🔥

Copy link
Member

@dzenanz dzenanz left a comment

Choose a reason for hiding this comment

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

Looks good on a glance.

@thewtex thewtex merged commit 497bfda into InsightSoftwareConsortium:master Nov 6, 2023
@thewtex thewtex deleted the download-page-releases branch November 6, 2023 17:11

**Guide and Textbook**

- [InsightSoftwareGuide-Book1-5.3.0.pdf](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.3.0/InsightSoftwareGuide-Book1-5.3.0.pdf)
Copy link
Member

Choose a reason for hiding this comment

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

All these links will be very hard to maintain.

@@ -357,7 +357,7 @@ Harassment will not be tolerated in any of its forms either. Specifically:

Although the above list cannot be exhaustive, we will not tolerate
discrimination based on any of the protected characteristics in our
[Diversity Statement](motivation.md#diversity-statement).
[Diversity Statement](motivation.md).
Copy link
Member

@jhlegarreta jhlegarreta Nov 6, 2023

Choose a reason for hiding this comment

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

This was working correctly, right?
#4268 (review)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:Documentation Issues affecting the Documentation module area:Python wrapping Python bindings for a class type:Infrastructure Infrastructure/ecosystem related changes, such as CMake or buildbots
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants