Skip to content

template-update #236

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
merged 4 commits into from
Apr 8, 2025
Merged

template-update #236

merged 4 commits into from
Apr 8, 2025

Conversation

emmurphy1
Copy link
Collaborator

Updated the comments in the templates to reflect what we know about potential issues with migrating to DITA.

@emmurphy1 emmurphy1 requested a review from a team as a code owner April 2, 2025 14:54
mjahoda
mjahoda reviewed Apr 2, 2025
View reviewed changes
Copy link
Contributor

@mjahoda mjahoda left a comment

Choose a reason for hiding this comment

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

I found only minor (potential) problems at very few lines. In general, this is a very good improvement of the templates. The text is much clearer now. Thank you.

laubai
laubai reviewed Apr 3, 2025
View reviewed changes
@emmurphy1
Copy link
Collaborator Author

@laubai and @mjahoda thank you so much for the comments. I have implemented most of them. Just waiting on Jaromir's feedback on a couple.

jhradilek
jhradilek reviewed Apr 3, 2025
View reviewed changes
modular-docs-manual/files/TEMPLATE_ASSEMBLY_a-collection-of-modules.adoc Outdated
////
Be sure to include a line break between the title and the :context: variable and the :context: variable and the assembly introduction.

Copy link
Contributor

Choose a reason for hiding this comment

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

The following line is the first time the instructions refer to lines above them. I find this confusing, it would make more sense to me to move this information to the comment above the ID and section title.

Copy link
Contributor

Choose a reason for hiding this comment

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

Similarly, the explanation of the :context: attribute would make more sense in this place, above the actual :context: attribute definition.

Copy link
Contributor

Choose a reason for hiding this comment

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

And as GitHub won't let me comment on those lines, all instructions regarding include statements would make more sense above the include statements, including the one about the empty line in between them. It would allow you to demonstrate that principle clearly without the includes being consistently interrupted with additional information.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done.

@emmurphy1 emmurphy1 merged commit 5230880 into redhat-documentation:main Apr 8, 2025
jhradilek added a commit to jhradilek/newdoc that referenced this pull request Apr 9, 2025
@jhradilek
Updated the templates to match the official ones.
98e81fb 
redhat-documentation/modular-docs#236 introduced
a few changes to the structure and the comments in the official
templates. This commit carries these changes over to newdoc with a few
notable exceptions:

  * I unified the empty space above and below the comment blocks. The
    upstream version is very inconsistent.
  * I unified the type of comments, The upstream version occasionally
    switches to line comments for no reason.
  * I moved the _mod-docs-content-type attribute definition in the
    assembly template to the top to match its position in the other
    templates.
  * I removed accidental leading spaces from some of the comments.
@jhradilek jhradilek mentioned this pull request Apr 9, 2025
Merged
jhradilek added a commit to jhradilek/newdoc that referenced this pull request Apr 9, 2025
@jhradilek
Updated the templates to match the official ones.
8597db8 
redhat-documentation/modular-docs#236 introduced
a few changes to the structure and the comments in the official
templates. This commit carries these changes over to newdoc with a few
notable adjustments:

  * I unified the empty space above and below the comment blocks. The
    upstream version is very inconsistent.
  * I unified the type of comments. The upstream version occasionally
    switches to line comments for no reason.
  * I moved the _mod-docs-content-type attribute definition in the
    assembly template to the top to match its position in the other
    templates.
  * I removed accidental leading spaces from some of the comments.
jhradilek added a commit to jhradilek/newdoc that referenced this pull request Apr 9, 2025
@jhradilek
Updated the templates to match the official ones.
9d98adb 
redhat-documentation/modular-docs#236 introduced
a few changes to the structure and the comments in the official
templates. This commit carries these changes over to newdoc with a few
notable adjustments:

  * I unified the empty space above and below the comment blocks. The
    upstream version is very inconsistent.
  * I unified the type of comments. The upstream version occasionally
    switches to line comments for no reason.
  * I moved the _mod-docs-content-type attribute definition in the
    assembly template to the top to match its position in the other
    templates.
  * I removed accidental leading spaces from some of the comments.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mjahoda mjahoda mjahoda left review comments

+2 more reviewers

@laubai laubai laubai left review comments

@jhradilek jhradilek jhradilek left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@emmurphy1 @laubai @jhradilek @mjahoda