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

Adjust to new help content #1641

Merged
merged 3 commits into from Oct 8, 2018
Merged

Adjust to new help content #1641

merged 3 commits into from Oct 8, 2018

Commits on Oct 5, 2018

  1. Replace helpFile property with help_id 

    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
    @M4rtinK
    M4rtinK committed Oct 5, 2018
    Configuration menu
    Copy the full SHA
    5677797 View commit details
    Browse the repository at this point in the history

  2. Update help folder paths 

    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
    @M4rtinK
    M4rtinK committed Oct 5, 2018
    Configuration menu
    Copy the full SHA
    b5e46d8 View commit details
    Browse the repository at this point in the history

  3. Adapt built in help system to new content structure 

    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
    M4rtinK committed Oct 5, 2018
    Configuration menu
    Copy the full SHA
    a681761 View commit details
    Browse the repository at this point in the history