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

Merge the VOL authors guide with the UG/RM #5072

Open
brtnfld opened this issue Nov 4, 2024 · 0 comments
Open

Merge the VOL authors guide with the UG/RM #5072

brtnfld opened this issue Nov 4, 2024 · 0 comments
Assignees
@byrnHDF
Labels
Component - Documentation Doxygen, markdown, etc. Priority - 2. Medium ⏹ It would be nice to have this in the next release Type - Task Actions that don't fit into any other type category
Milestone
2.0.0

Comments

@brtnfld
Copy link
Contributor

brtnfld commented Nov 4, 2024

The VOL author's guide contains much of the same content as the Doxygen H5VL documentation. The repeated documentation should be eliminated, and its original content should be added as a section of the H5VLDEV group in the documentation.

The use of the modules
[Definitions],[Native VOL],[Pass-through VOL],[VOL Developer]

has many developer APIs that can fall into other categories, leaving ambiguity as to where to look (or place) APIs.
@brtnfld brtnfld added the Component - Documentation Doxygen, markdown, etc. label Nov 4, 2024
@derobins derobins changed the title Eliminated the VOL's author's guide as a seperate document. Eliminate the VOL's author's guide as a separate document Nov 4, 2024
@derobins derobins added this to the 2.0.0 milestone Nov 4, 2024
@derobins derobins changed the title Eliminate the VOL's author's guide as a separate document Eliminate the VOL author's guide as a separate document Nov 5, 2024
@derobins derobins changed the title Eliminate the VOL author's guide as a separate document Merge the VOL authors guide with the UG/RM Nov 7, 2024
@derobins derobins added Priority - 2. Medium ⏹ It would be nice to have this in the next release Type - Task Actions that don't fit into any other type category labels Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@byrnHDF byrnHDF

Labels
Component - Documentation Doxygen, markdown, etc. Priority - 2. Medium ⏹ It would be nice to have this in the next release Type - Task Actions that don't fit into any other type category
Projects
None yet
Milestone
2.0.0
Development

No branches or pull requests
3 participants
@derobins @brtnfld @byrnHDF