GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — issue 175 - adding an assembly attribute by kalexand-rh · Pull Request #176 · redhat-documentation/modular-docs

Conversation

@kalexand-rh

@kalexand-rh kalexand-rh commented Nov 3, 2021

Copy link
Copy Markdown
Contributor

Fixes #175

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@kalexand-rh
kalexand-rh requested a review from a team as a code owner November 3, 2021 19:42
@sterobin

sterobin commented Nov 10, 2021

Copy link
Copy Markdown
Contributor

Updated #175 to summarize the proposal.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@kalexand-rh
issue 175 - adding an assembly attribute
3312b13
@kalexand-rh
kalexand-rh force-pushed the doc-type branch from 696234e to 3312b13 Compare November 10, 2021 13:09
sterobin
sterobin reviewed Nov 10, 2021
View reviewed changes
Comment thread modular-docs-manual/content/topics/using-text-snippets.adoc Outdated
+
NOTE: Consider storing snippet files in a separate snippets folder.

. Add a variable to the snippet files that that identifies its content type:

@sterobin sterobin Nov 10, 2021

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

@kalexand-rh Typo "that that"

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
sterobin
sterobin reviewed Nov 10, 2021
View reviewed changes

@sterobin sterobin left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Thanks @kalexand-rh . Just a couple minor comments.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread modular-docs-manual/content/topics/module_anchor-and-file-names-concept.adoc Outdated
====

These file naming guidelines are optional but highly recommended. However, if your team does not include the module prefixes in file names followed by either a hyphen (-) or an underscore (_), include one of the following variables in each concept, procedure, and reference module before the module ID:
These file naming guidelines are optional but highly recommended. However, if your team does not include the module prefixes in file names followed by either a hyphen (-) or an underscore (_), include one of the following variables in each assembly file and concept, procedure, and reference module before the module ID:

@sterobin sterobin Nov 10, 2021

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Suggested change
These file naming guidelines are optional but highly recommended. However, if your team does not include the module prefixes in file names followed by either a hyphen (-) or an underscore (_), include one of the following variables in each assembly file and concept, procedure, and reference module before the module ID:
These file naming guidelines are optional but highly recommended. However, if your team does not include the prefixes in file names followed by either a hyphen (-) or an underscore (_), include one of the following variables in each file before the anchor ID:

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
sterobin
sterobin reviewed Nov 10, 2021
View reviewed changes
Comment thread modular-docs-manual/content/topics/module_anchor-and-file-names-concept.adoc Outdated
:_content-type: ASSEMBLY
:_content-type: CONCEPT
:_content-type: PROCEDURE
:_content-type: REFERENCE

@sterobin sterobin Nov 10, 2021 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Just a side note that I think is outside of the scope of this PR. We might want to update the intro section to this chap to also mention snippets, and include a snippet file in the example file names previously in this section, and then add a content-type of SNIPPET to this list. But snippets are still fairly new territory, so not sure if we're to a point that we want to mention it beyond the snippets section later in this guide, which you've correctly updated. So I think good for now unless someone wants to expand this section to include snippets in a separate PR.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@kalexand-rh
updates per Stetson
9929e7e
@sterobin sterobin added the Discussion for discussion topics that may later become enhancements label Dec 8, 2021
@sterobin

sterobin commented Dec 8, 2021 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

In mod doc review board meeting Dec 8, 2021, decided to freeze this PR until the dust settles with Jupiter post-Summit to ensure that the requirements don't again change, and also to see at that point if we can get a concrete answer on how the distinction of content and even module type has actual customer value beyond just a new tooling requirement. To be discussed post-Summit.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@emmurphy1
emmurphy1 merged commit b3cbfe1 into redhat-documentation:master Mar 22, 2022
@emmurphy1 emmurphy1 mentioned this pull request Mar 24, 2022
Update the snippets sections #186
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@sterobin sterobin sterobin left review comments
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

Discussion for discussion topics that may later become enhancements

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add an assembly attribute option

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@kalexand-rh @sterobin @emmurphy1
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.