Skip to content

[irods/irods#8752] Indexing: Rewrite documentation (main) #398

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
Merged
alanking merged 2 commits into from
Jan 6, 2026
Merged

[irods/irods#8752] Indexing: Rewrite documentation (main) #398

alanking merged 2 commits into from
Jan 6, 2026

Conversation

@alanking
Copy link
Contributor

@alanking alanking commented Jan 5, 2026

Addresses irods/irods#8752

korydraughn
korydraughn reviewed Jan 6, 2026
View reviewed changes
Copy link
Collaborator

@korydraughn korydraughn 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 overall.

These pages duplicate info that's available in the repos. I'm wondering if we should just link to the repos. Will continue to think about that.

Not a blocker for this PR.

alanking
alanking commented Jan 6, 2026
View reviewed changes
Copy link
Contributor Author

@alanking alanking left a comment

Choose a reason for hiding this comment

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

These pages duplicate info that's available in the repos. I'm wondering if we should just link to the repos. Will continue to think about that.

I thought about this as well. If these pages continue to exist, my thought is that it should be a more detailed version of the GitHub READMEs and targeted at users / administrators, whereas the GitHub READMEs should be more targeted at developers. That's just my two cents.

My main goal for this PR was to make the information on the page true / up to date, and I didn't really feel like trying the Metalnx demo :)

korydraughn
korydraughn reviewed Jan 6, 2026
View reviewed changes
Copy link
Collaborator

@korydraughn korydraughn left a comment

Choose a reason for hiding this comment

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

Squash it.

alanking
alanking commented Jan 6, 2026
View reviewed changes
Copy link
Contributor Author

@alanking alanking left a comment

Choose a reason for hiding this comment

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

Squashed

korydraughn
korydraughn approved these changes Jan 6, 2026
View reviewed changes
Copy link
Collaborator

@korydraughn korydraughn left a comment

Choose a reason for hiding this comment

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

Pound it.

@alanking
[irods/irods#8752] Indexing: Remove document_type
73d3304 
This plugin no longer exists.
@alanking
[irods/irods#8752] Indexing: Rewrite documentation
2056839 
This commit rewrites the Indexing Capability documentation to align
with relatively recent updates as well as existing training.
@alanking
Copy link
Contributor Author

alanking commented Jan 6, 2026

#'d, mergin

@alanking alanking merged commit 9246fef into irods:main Jan 6, 2026
2 checks passed
@alanking alanking deleted the 8752.m branch January 6, 2026 16:48
@alanking alanking mentioned this pull request Jan 6, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@korydraughn korydraughn korydraughn approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@alanking @korydraughn