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.

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

Remove all support of the built-in help system #5335

Merged
merged 1 commit into from
Nov 21, 2023

Conversation

poncovka
Copy link
Contributor

@poncovka poncovka commented Nov 20, 2023

The support of the built-in help accessible from spokes and hubs of all user interfaces is removed. The help_directory Anaconda configuration option is deprecated and removed. The anaconda-user-help package will be deprecated and removed.

Anaconda will aim to make user interfaces self-descriptive and encourage users to use the official documentation of specific Linux distributions available on-line.

Additional notes:

  • The Fedora built-in help content was outdated. Last change of the content happened six years ago (see the anaconda-user-help repository) and there is no process for keeping the help content up to date.

  • The RHEL built-in help content was generated from the official on-line installation guide. However, the release process of this content wasn't always straightforward and there were issues with the scripts that generated this content.

  • The built-in help content was displayed by the yelp tool. This tool was a common source of bugs, so it is desirable to drop this dependency.

Resolves: #INSTALLER-3758

TODO:

  • Write a release note.
  • Verify the impact on Anaconda add-ons, Anaconda Initial Setup and Blivet GUI.
  • Test the changes.

@poncovka
Copy link
Contributor Author

/build-image --boot.iso

Copy link

Images built based on commit ccc7749:

  • boot.iso: success

Download the images from the bottom of the job status page.

Copy link
Contributor

@KKoukiou KKoukiou left a comment

Choose a reason for hiding this comment

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

Please link the INSTALLER jira link with:

Resolves: #INSTALLER-xyz

The support of the built-in help accessible from spokes and hubs of all user
interfaces is removed. The `help_directory` Anaconda configuration option is
deprecated and removed. The `anaconda-user-help` package will be deprecated
and removed.

Anaconda will aim to make user interfaces self-descriptive and encourage users
to use the official documentation of specific Linux distributions available
on-line.

Additional notes:

* The Fedora built-in help content was outdated. Last change of the content
  happened six years ago (see the `anaconda-user-help` repository) and there
  is no process for keeping the help content up to date.

* The RHEL built-in help content was generated from the official on-line
  installation guide. However, the release process of this content wasn't
  always straightforward and there were issues with the scripts that generated
  this content.

* The built-in help content was displayed by the `yelp` tool. This tool was
  a common source of bugs, so it is desirable to drop this dependency.

Resolves: #INSTALLER-3758
@poncovka poncovka marked this pull request as ready for review November 20, 2023 18:12
@poncovka poncovka added the notable change Important changes like API change, behavior change... label Nov 20, 2023
@poncovka
Copy link
Contributor Author

/kickstart-test --testtype smoke

@poncovka
Copy link
Contributor Author

@AdamWill Just a heads up, it might break the Fedora QA tests.

Copy link
Contributor

@KKoukiou KKoukiou left a comment

Choose a reason for hiding this comment

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

@poncovka poncovka merged commit a0bf721 into rhinstaller:master Nov 21, 2023
18 checks passed
@AdamWill AdamWill mentioned this pull request Nov 24, 2023
@AdamWill
Copy link
Contributor

Release criteria updated, wiki test case marked obsolete, openQA test case removed.

tpopela added a commit to tpopela/content-resolver-input that referenced this pull request Dec 4, 2023
We're removing WebKitGTK[[0] from RHEL 10 and one of the applications
that are using it is Yelp which is the default help viewer in GNOME[1].
We do have some plans[2] on how to rework the whole thing so the
existing help is diplayed in the default browser. But until we agree
on something (and implement it) we shouldn't block the WebKitGTK
removal and rather temporarily remove it. It used to be required by
Anaconda as well, but the dependency was dropped with [3] which is part
of the ELN [4].

[0] - https://issues.redhat.com/browse/DESKTOP-670
[1] - https://issues.redhat.com/browse/DESKTOP-679
[2] - https://gitlab.gnome.org/GNOME/yelp-tools/-/merge_requests/12
[3] - rhinstaller/anaconda#5335
[4] - https://koji.fedoraproject.org/koji/buildinfo?buildID=2325587
bstinsonmhk pushed a commit to minimization/content-resolver-input that referenced this pull request Dec 5, 2023
We're removing WebKitGTK[[0] from RHEL 10 and one of the applications
that are using it is Yelp which is the default help viewer in GNOME[1].
We do have some plans[2] on how to rework the whole thing so the
existing help is diplayed in the default browser. But until we agree
on something (and implement it) we shouldn't block the WebKitGTK
removal and rather temporarily remove it. It used to be required by
Anaconda as well, but the dependency was dropped with [3] which is part
of the ELN [4].

[0] - https://issues.redhat.com/browse/DESKTOP-670
[1] - https://issues.redhat.com/browse/DESKTOP-679
[2] - https://gitlab.gnome.org/GNOME/yelp-tools/-/merge_requests/12
[3] - rhinstaller/anaconda#5335
[4] - https://koji.fedoraproject.org/koji/buildinfo?buildID=2325587
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation f40 notable change Important changes like API change, behavior change...
Development

Successfully merging this pull request may close these issues.

3 participants