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

stable version of gramine readthedocs is not updated with changes done as part of v1.8 release #2066

Open
anjalirai-intel opened this issue Nov 21, 2024 · 3 comments · May be fixed by #2073
Assignees

Comments

@anjalirai-intel
Copy link
Contributor

anjalirai-intel commented Nov 21, 2024

Description of the problem

The Gramine stable documentation on readthedocs is not updated with the changes done as part of v1.8 release

There are several other sections that need attention, but here are a few examples:

latest version:

  1. CMake is listed as a required package.
    Required Packages
    https://gramine.readthedocs.io/en/latest/devel/building.html#required-packages
sudo apt-get install -y cmake libprotobuf-c-dev protobuf-c-compiler \
    protobuf-compiler python3-cryptography python3-pip python3-protobuf
  1. Ubuntu 24.04 is included in the supported versions.
    Install Gramine Packages
    https://gramine.readthedocs.io/en/latest/installation.html#install-gramine-packages

stable version:

  1. In the Required Packages section, CMake is missing from the list.
    Required Packages
    https://gramine.readthedocs.io/en/stable/devel/building.html#required-packages
sudo apt-get install -y libprotobuf-c-dev protobuf-c-compiler \
    protobuf-compiler python3-cryptography python3-pip python3-protobuf
  1. Ubuntu 24.04 support is missing in the Install Gramine section.
    Install Gramine Packages
    https://gramine.readthedocs.io/en/stable/installation.html#install-gramine-packages-1

All changes released as part of v1.8 are missing from the stable readthedocs. It should be updated.

Steps to reproduce

No response

Expected results

No response

Actual results

No response

Gramine commit hash

e140552

@kailun-qin
Copy link
Contributor

In the Required Packages section, CMake is missing from the list.

I think this is because our ReadTheDocs build for the stable branch is temporarily failing. cc @woju

See https://gramine.readthedocs.io/en/v1.8/devel/building.html#required-packages which shows the expected.

Ubuntu 24.04 support is missing in the Install Gramine section.

Given that the subsection text was updated post v1.8 release (the installation instructions are the same): f499271, I don't know if it can still be fixed.

@woju
Copy link
Member

woju commented Nov 29, 2024

Fixed in PR #2073, please see. Unfortunately, to rebuild stable version on RTD, we need to push a tag, so this means we need to do a release. Either 1.8.1 from a branch, where I backport the fix from #2073, or we wait for 1.9.

@mkow
Copy link
Member

mkow commented Nov 29, 2024

I think we can wait, it's a lot of effort to do a release (even minor).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants