Skip to content

Convert several .txt in release_docs folder to Markdown#6263

Open
ajelenak wants to merge 6 commits intoHDFGroup:developfrom
ajelenak:reldocs-to-md
Open

Convert several .txt in release_docs folder to Markdown#6263
ajelenak wants to merge 6 commits intoHDFGroup:developfrom
ajelenak:reldocs-to-md

Conversation

@ajelenak
Copy link
Contributor

@ajelenak ajelenak commented Mar 3, 2026

Closes #6248.

Several .txt files in the release_docs folder with installation instructions are converted to Markdown. Cross-referencing in them was updated for the new .md files. A table of contents with section links was added to each one.


Important

Convert several installation instruction files in release_docs from .txt to .md, updating cross-references and adding a table of contents.

  • Conversion to Markdown:
    • Convert INSTALL, INSTALL_CMake, INSTALL_Cygwin, INSTALL_S3, INSTALL_Windows, USING_CMake_Examples, and USING_HDF5_CMake from .txt to .md.
  • Cross-referencing:
    • Update cross-references in the converted files to point to new .md files.
  • Table of Contents:
    • Add a table of contents with section links to each converted file.

This description was created by Ellipsis for 0d5e7f3. You can customize this summary. It will automatically update as commits are pushed.

brtnfld
brtnfld previously approved these changes Mar 3, 2026
@github-project-automation github-project-automation bot moved this from To be triaged to In progress in HDF5 - TRIAGE & TRACK Mar 4, 2026
@ajelenak
Copy link
Contributor Author

ajelenak commented Mar 4, 2026

@brtnfld Need your approval again unfortunately.

@ajelenak ajelenak requested review from brtnfld and hyoklee March 4, 2026 14:29
[USING_HDF5_CMake.md](./USING_HDF5_CMake.md) file found in this folder.

Users who want to build and run an application with HDF5 in Visual Studio
without using CMake should consult the [USING_HDF5_VS.txt](./USING_HDF5_VS.txt) file. Building
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should USING_HDF5_VS.txt be converted as well?

Copy link
Collaborator

Choose a reason for hiding this comment

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

It seems like a significant amount of useful information was removed from this file, especially in sections 5, 6, 7, 10, 11 and 13. I'm a bit hesitant about removing all of this information without it being somewhere else.

@ajelenak
Copy link
Contributor Author

ajelenak commented Mar 4, 2026

You have awaken a beast...😉 I found some .txt holdovers in the previously converted Markdown files. Hopefully all those are now updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In progress

Development

Successfully merging this pull request may close these issues.

Convert release_docs from plain text to markdown

4 participants