-
Notifications
You must be signed in to change notification settings - Fork 78
WIP: issue-116-emily #116: Guideline against "pseudo modules" is problematic #161
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
43c8a02
issue-116-emily updated snippets section
emmurphy1 52dc13f
issue-116-emily added note about modules including modules
emmurphy1 4d8ae3a
issue-116-emily
emmurphy1 778e825
issue-116-emily clarified snippet definition
emmurphy1 2729139
issue-116-emily updated with review comments. Changed snippets to fra…
emmurphy1 a70e483
Update modular-docs-manual/content/topics/using_text_fragments.adoc
emmurphy1 325940d
issue-116-emily updated with RK's suggestions
emmurphy1 1f84e13
issue-116-emily removed typo
emmurphy1 5d7702b
issue-116-emily updated with Preeti's comment
emmurphy1 34cde3f
issue-116-emily revised text frag note
emmurphy1 2db2f6c
issue 116 changed fragments to snippets
emmurphy1 cd7ef57
issue-116-emily updated xref
emmurphy1 30164a1
issue-116-emily fixed include file name
emmurphy1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
modular-docs-manual/content/topics/module_what-modular-documentation-is.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
21 changes: 21 additions & 0 deletions
21
modular-docs-manual/content/topics/using-text-snippets.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
[id="using-text-snippets"] | ||
|
||
= Text Snippets | ||
|
||
A text snippet is a small section of text that is stored in an AsciiDoc file. Text snippets contain content that is resused in multiple modules or assemblies, for example: | ||
|
||
* A step or series of steps in a procedure | ||
* A disclaimer, for example, for technology preview or beta releases | ||
|
||
NOTE: A text snippet is not a module. | ||
|
||
.Procedure | ||
. Create the text snippet AsciiDoc file. | ||
+ | ||
NOTE: Consider storing snippet files in a separate snippets folder. | ||
. Add an `include::` statement to the file that you want to add the snippet to, for example: | ||
+ | ||
[source] | ||
---- | ||
include::snippets/beta-note.adoc | ||
---- |
26 changes: 0 additions & 26 deletions
26
modular-docs-manual/content/topics/using_text_snippets_or_text_fragments.adoc
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
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.
@sterobin can you see why this xref isn't working?
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.
Fixed. Thanks Stetson.