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

Generate plugin documentation from their sources #2549

Merged
merged 1 commit into from
Feb 3, 2024
Merged

Generate plugin documentation from their sources #2549

merged 1 commit into from
Feb 3, 2024

Conversation

happz
Copy link
Collaborator

@happz happz commented Dec 5, 2023 •
edited
Loading

This required a small refactoring of how field properties were stored. Instead of treating them as something owned by CLI options, they have their use outside of CLI area, and must exist in field metadata to be consumable in general.

Now we have a template, a script, a section in docs. Fixing the content would be the next step...

Pull Request Checklist

  • implement the feature
  • write the documentation

@happz happz added the documentation Improvements or additions to documentation label Dec 5, 2023
@happz happz added this to the 1.31 milestone Dec 5, 2023
@happz happz force-pushed the docs-plugins-from-template-and-sources branch from f5fba70 to 70c9ea8 Compare December 8, 2023 10:32
@happz happz force-pushed the docs-plugins-rename branch 2 times, most recently from edc4734 to f564b1d Compare December 14, 2023 12:31
@happz happz force-pushed the docs-plugins-from-template-and-sources branch from 70c9ea8 to 09e97dc Compare December 15, 2023 15:47
@happz happz force-pushed the docs-plugins-from-template-and-sources branch from 09e97dc to 49af58e Compare December 15, 2023 15:52
@happz happz mentioned this pull request Dec 15, 2023
Open
@happz happz force-pushed the docs-plugins-rename branch 2 times, most recently from 49b9ddb to 722af16 Compare January 3, 2024 22:16
Base automatically changed from docs-plugins-rename to main January 4, 2024 08:35
@happz happz force-pushed the docs-plugins-from-template-and-sources branch from 49af58e to e19d8f0 Compare January 4, 2024 08:46
@happz happz mentioned this pull request Jan 4, 2024
Merged
2 tasks
@happz happz force-pushed the docs-plugins-from-template-and-sources branch 3 times, most recently from f6351a7 to 044dbed Compare January 10, 2024 08:38
@happz happz mentioned this pull request Jan 15, 2024
Merged
1 task
@happz happz force-pushed the docs-plugins-from-template-and-sources branch 2 times, most recently from 2ffecd3 to e3282e0 Compare January 17, 2024 08:25
@happz happz marked this pull request as ready for review January 18, 2024 10:30
@happz happz force-pushed the docs-plugins-from-template-and-sources branch from a551f2e to a2933ec Compare January 23, 2024 09:29
@thrix thrix added the status | blocking other work An important pull request, blocking other pull requests or issues label Jan 23, 2024
@happz happz force-pushed the docs-plugins-from-template-and-sources branch from a2933ec to 8d2ef47 Compare January 26, 2024 08:36
@happz happz force-pushed the docs-plugins-from-template-and-sources branch 2 times, most recently from 1dc5dc9 to 93eceec Compare January 31, 2024 11:28
@happz
Copy link
Collaborator Author

happz commented Jan 31, 2024

/packit test -i full

@happz happz force-pushed the docs-plugins-from-template-and-sources branch from 93eceec to b197b2e Compare February 2, 2024 14:15
@happz @psss
Generate plugin documentation from their sources
e5256ca 
This required a small refactoring of how field properties were stored.
Instead of treating them as something owned by CLI options, they have
their use outside of CLI area, and must exist in field metadata to be
consumable in general.

Now we have a template, a script, a section in docs. Fixing the content
would be the next step...
@psss psss force-pushed the docs-plugins-from-template-and-sources branch from b197b2e to e5256ca Compare February 3, 2024 13:14
psss
psss approved these changes Feb 3, 2024
View reviewed changes
Copy link
Collaborator

@psss psss left a comment

Choose a reason for hiding this comment

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

Beautiful, elegant, and... just awesome! This will save us a lot of duplicated documentation code. Thanks much for implementing this. Looks great, I just capitalized the heading.

@psss
Copy link
Collaborator

psss commented Feb 3, 2024

/packit test -i full

@psss
Copy link
Collaborator

psss commented Feb 3, 2024

/packit test -i provision

@happz
Copy link
Collaborator Author

happz commented Feb 3, 2024

Beautiful, elegant, and... just awesome! This will save us a lot of duplicated documentation code. Thanks much for implementing this. Looks great, I just capitalized the heading.

Glad to hear you like it. Please, check also the second PR, #2574, in a way they are sort of two parts of the same "virtual PR". #2549 adds a template and some basic changes, and #2574 builds on top of them by improving the template, adding more changes, CLI rendering, and multiple plugin changes to make them better play with ReST. I was hoping that we might merge them both, with not that many questions asked, because in some ways, they are also incomplete - the changes made to plugins are significant, but by no means complete. The review tracked in #2657 will result in more changes, resolving many, many loose ends you may easily find in both these pull requests - I just felt it's probably time to stop here and now, when it finally works, and leave the cleanup to per-plugin PRs.

@psss psss self-assigned this Feb 3, 2024
@psss psss merged commit 1b6ac46 into main Feb 3, 2024
19 checks passed
@psss psss deleted the docs-plugins-from-template-and-sources branch February 3, 2024 16:49
@psss
Copy link
Collaborator

psss commented Feb 5, 2024

Ack. Yeah, makes sense. I'll finish that one before leaving for PTO.

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

@psss psss psss approved these changes

@lukaszachy lukaszachy Awaiting requested review from lukaszachy lukaszachy is a code owner

@thrix thrix Awaiting requested review from thrix thrix is a code owner

@janhavlin janhavlin Awaiting requested review from janhavlin janhavlin is a code owner

Assignees

@psss psss

Labels
documentation Improvements or additions to documentation status | blocking other work An important pull request, blocking other pull requests or issues
Projects
None yet
Milestone
1.31
Development

Successfully merging this pull request may close these issues.
3 participants
@happz @psss @thrix