Adjust to new help content #1641
Merged
Conversation
This file contains 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
M4rtinK
changed the title
jkonecny12
approved these changes
Oct 5, 2018
pyanaconda/ihelp.py
Outdated
| return placeholder_path | ||
| else: | ||
| log.error("placeholder {placeholder_name} not found in {help_folder}".format(placeholder_name=instclass.help_placeholder, | ||
| help_folder=instclass.help_folder)) |
There was a problem hiding this comment.
In this particular case I would prefer to use just {} instead of the long name. It is not used for translation and it should be able to get to one line, thought.
There was a problem hiding this comment.
Sounds good, changed! :)
M4rtinK
force-pushed
the
rhel-devel-adjust_to_new_help_content
branch
2 times, most recently
from
b46a46d
to
4583464
Compare
Previously we used to have one help content file per screen, which no longer works for the new help content, which is using a single docbook file with anchors. So replace the helpFile property with a help_id property, which holds a unique string id corresponding to one screen needing help. The help id can then be mapped into an anchor in the main docbook file, or even something else if needed. Related: rhbz#1593723
For RHEL the help content needs to go to the "rhel" sup folder in case some layer products will want to include their branded help content in the future. Also drop the "placeholder_with_links" placeholder variant, which is no longer really used anyway. Related: rhbz#1593723
The structure of the help content has been changed and the Anaconda built in help handling needs to be adjusted accordingly: - single docbook file indexed via anchors - help ids instead of hardcoded per-screen file names - help id -> anchor translation table supplied by the anaconda-user-help package - support for branded documentation variants Resolves: rhbz#1593723
M4rtinK
force-pushed
the
rhel-devel-adjust_to_new_help_content
branch
from
4583464
to
a681761
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull requests adapts anaconda to changes in help content formatting.