Enhancing The Update Framework (Python - TUF) README #2655

shubhusion · 2024-06-08T19:10:39Z

Description of the changes being introduced by the pull request:

Table of Contents: Added a Table of Contents to improve navigation and accessibility within the README.
Logo Color: Changed the logo color from black to white to enhance visibility and improve the overall aesthetic of the document.
Additional Badges: Included additional badges to highlight key aspects such as version, license, tech-stack, and community support, providing users with quick access to essential information.
Back to Top Button: Added a "Back to Top" button at the bottom of the README to facilitate easy navigation within the document.
Installation Section: Added an Installation section to provide users with clear guidance on how to install the software.
Contact Section Enhancement: Separated the Mailing List and CNCF Slack links for better readability and organization within the Contact section.
CNCF Logo Addition: Added the CNCF logo at the bottom of the README to acknowledge the project's affiliation with the Cloud Native Computing Foundation.

Before:

After:

Fixes #2654

Reviewers:

@trishankatdatadog @JustinCappos

shubhusion · 2024-06-09T19:23:02Z

@trishankatdatadog @JustinCappos please review this PR for the issue #2654

jku · 2024-06-17T06:53:23Z

2. Logo Color: Changed the logo color from black to white to enhance visibility and improve the overall aesthetic of the document.

This change makes the logo invisible with default GitHub settings (You are using dark theme on GitHub so see the opposite effect).

shubhusion · 2024-06-17T07:58:34Z

Logo Color: Changed the logo color from black to white to enhance visibility and improve the overall aesthetic of the document.

This change makes the logo invisible with default GitHub settings (You are using dark theme on GitHub so see the opposite effect).

To ensure the logo is visible in both light and dark themes, a solution that automatically switches the logo based on the user's selected theme preference can be implemented. This strategy involves utilizing two different logo versions (one for light theme and one for a dark theme) and utilizing HTML and CSS to manage the theme-based switching.

coveralls · 2024-06-17T09:33:43Z

Pull Request Test Coverage Report for Build 9544443646

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 96.805%

Totals
Change from base Build 9362602883:	0.0%
Covered Lines:	1554
Relevant Lines:	1591

💛 - Coveralls

shubhusion · 2024-06-17T10:25:57Z

@jku it works for both light and dark theme now. please have a look

jku

I've not looked at the text content changes(would appreciate someone else having a look).

Structural changes look nice (like use of actual headers) but I left comments on the urls etc

README.md

trishankatdatadog · 2024-07-23T21:41:53Z

@trishankatdatadog @JustinCappos please review this PR for the issue #2654

Sorry, I'm running out of B/W... please try someone else? @jku has been massively helpful here, thanks!

lukpueh · 2024-07-24T08:38:52Z

@jku already left a thorough review here. From what I see, the key improvement of this PR is to use the correct markup for the section headers. @shubhusion, do you plan to address the review comments?

shubhusion · 2024-07-27T18:41:01Z

@jku already left a thorough review here. From what I see, the key improvement of this PR is to use the correct markup for the section headers. @shubhusion, do you plan to address the review comments?

@lukpueh yeah I will make changes as specified

…mework#2642) * Make commands easier to copy Signed-off-by: h4l0gen <[email protected]> Signed-off-by: Kapil Sharma <[email protected]> Signed-off-by: shubhusion <[email protected]>

Bumps the test-and-lint-dependencies group with 2 updates: [coverage](https://github.com/nedbat/coveragepy) and [ruff](https://github.com/astral-sh/ruff). Updates `coverage` from 7.5.2 to 7.5.3 - [Release notes](https://github.com/nedbat/coveragepy/releases) - [Changelog](https://github.com/nedbat/coveragepy/blob/master/CHANGES.rst) - [Commits](nedbat/coveragepy@7.5.2...7.5.3) Updates `ruff` from 0.4.5 to 0.4.7 - [Release notes](https://github.com/astral-sh/ruff/releases) - [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md) - [Commits](astral-sh/ruff@v0.4.5...v0.4.7) --- updated-dependencies: - dependency-name: coverage dependency-type: direct:production update-type: version-update:semver-patch dependency-group: test-and-lint-dependencies - dependency-name: ruff dependency-type: direct:production update-type: version-update:semver-patch dependency-group: test-and-lint-dependencies ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: shubhusion <[email protected]>

* repository: Handle online key change situations in do_snapshot() and do_timestamp(): always create a new version if current version is not correctly signed * remove expectedFailure marks from the related tests Signed-off-by: h4l0gen <[email protected]> Signed-off-by: Kapil Sharma <[email protected]> Signed-off-by: shubhusion <[email protected]>

Signed-off-by: SHUBHAM SHARMA <[email protected]> Signed-off-by: shubhusion <[email protected]>

Signed-off-by: shubhusion <[email protected]>

Signed-off-by: SHUBHAM SHARMA <[email protected]> Signed-off-by: shubhusion <[email protected]>

…mework#2657) Bumps the dependencies group with 2 updates: [cryptography](https://github.com/pyca/cryptography) and [securesystemslib[crypto,pynacl]](https://github.com/secure-systems-lab/securesystemslib). Updates `cryptography` from 42.0.7 to 42.0.8 - [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst) - [Commits](pyca/cryptography@42.0.7...42.0.8) Updates `securesystemslib[crypto,pynacl]` from 1.0.0 to 1.1.0 - [Release notes](https://github.com/secure-systems-lab/securesystemslib/releases) - [Changelog](https://github.com/secure-systems-lab/securesystemslib/blob/main/CHANGELOG.md) - [Commits](secure-systems-lab/securesystemslib@v1.0.0...v1.1.0) --- updated-dependencies: - dependency-name: cryptography dependency-type: direct:production update-type: version-update:semver-patch dependency-group: dependencies - dependency-name: securesystemslib[crypto,pynacl] dependency-type: direct:production update-type: version-update:semver-minor dependency-group: dependencies ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: shubhusion <[email protected]>

Bumps the test-and-lint-dependencies group with 1 update: [ruff](https://github.com/astral-sh/ruff). Updates `ruff` from 0.4.7 to 0.4.8 - [Release notes](https://github.com/astral-sh/ruff/releases) - [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md) - [Commits](astral-sh/ruff@v0.4.7...v0.4.8) --- updated-dependencies: - dependency-name: ruff dependency-type: direct:production update-type: version-update:semver-patch dependency-group: test-and-lint-dependencies ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: shubhusion <[email protected]>

Signed-off-by: SHUBHAM SHARMA <[email protected]> Signed-off-by: shubhusion <[email protected]>

Bumps the test-and-lint-dependencies group with 2 updates: [coverage](https://github.com/nedbat/coveragepy) and [ruff](https://github.com/astral-sh/ruff). Updates `coverage` from 7.5.2 to 7.5.3 - [Release notes](https://github.com/nedbat/coveragepy/releases) - [Changelog](https://github.com/nedbat/coveragepy/blob/master/CHANGES.rst) - [Commits](nedbat/coveragepy@7.5.2...7.5.3) Updates `ruff` from 0.4.5 to 0.4.7 - [Release notes](https://github.com/astral-sh/ruff/releases) - [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md) - [Commits](astral-sh/ruff@v0.4.5...v0.4.7) --- updated-dependencies: - dependency-name: coverage dependency-type: direct:production update-type: version-update:semver-patch dependency-group: test-and-lint-dependencies - dependency-name: ruff dependency-type: direct:production update-type: version-update:semver-patch dependency-group: test-and-lint-dependencies ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps the test-and-lint-dependencies group with 1 update: [ruff](https://github.com/astral-sh/ruff). Updates `ruff` from 0.4.7 to 0.4.8 - [Release notes](https://github.com/astral-sh/ruff/releases) - [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md) - [Commits](astral-sh/ruff@v0.4.7...v0.4.8) --- updated-dependencies: - dependency-name: ruff dependency-type: direct:production update-type: version-update:semver-patch dependency-group: test-and-lint-dependencies ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: shubhusion <[email protected]>

Signed-off-by: shubhusion <[email protected]>

Signed-off-by: SHUBHAM SHARMA <[email protected]>

coveralls · 2024-07-29T08:35:53Z

Pull Request Test Coverage Report for Build 10125811756

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 96.805%

Totals
Change from base Build 10083770686:	0.0%
Covered Lines:	1554
Relevant Lines:	1591

💛 - Coveralls

jku

There are now unused pngs included in the PR: please remove those
There are some issues with the CNCF section at the bottom, left a comment there

Note to PR merger: If the pngs are in any commit in the PR, this should be squash merged to prevent them from being part of git history

jku · 2024-08-19T07:04:21Z

README.md

+## <div align="center"> The Update Framework (TUF) is a CNCF graduated project </div>
+
+<div align="center">
+  <a href="https://www.cncf.io/">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://github.com/shubhusion/python-tuf/blob/develop/cncf-white.png">
+      <source media="(prefers-color-scheme: light)" srcset="https://github.com/shubhusion/python-tuf/blob/develop/cncf-black.png">
+      <img src="https://github.com/shubhusion/python-tuf/blob/develop/cncf-black.png" height="150" alt="TUF" style="background-color:white"/>
+    </picture>
+  </a>
+</div>


links to "https://github.com/shubhusion/ are still not ok

I also wonder if CNCF really needs a second level title and a huge logo in addition to the acknowledgement it already had. We could just tweak the previous CNCF reference in "Acknowledgements" to include the mention of being a graduated project?

jku · 2024-10-22T07:37:59Z

I'm closing this since no action in 2 months.

Please reopen if you get to it at a later date

shubhusion force-pushed the develop branch from cab4ef5 to e7cd71b Compare June 9, 2024 19:21

shubhusion force-pushed the develop branch from 4cbf0dd to c39f3ab Compare June 17, 2024 10:19

jku requested changes Jun 17, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

h4l0gen and others added 19 commits July 28, 2024 00:38

Updating Contributing guidelines and copy-pastable code (theupdatefra…

3f09c36

…mework#2642) * Make commands easier to copy Signed-off-by: h4l0gen <[email protected]> Signed-off-by: Kapil Sharma <[email protected]> Signed-off-by: shubhusion <[email protected]>

Update README.md

101d0f8

Signed-off-by: SHUBHAM SHARMA <[email protected]> Signed-off-by: shubhusion <[email protected]>

Update README.md

7114543

Signed-off-by: SHUBHAM SHARMA <[email protected]> Signed-off-by: shubhusion <[email protected]>

Update README.md

5958af8

Signed-off-by: SHUBHAM SHARMA <[email protected]> Signed-off-by: shubhusion <[email protected]>

Update README.md

26bba18

Signed-off-by: SHUBHAM SHARMA <[email protected]> Signed-off-by: shubhusion <[email protected]>

Update README.md

2bde4a6

Signed-off-by: SHUBHAM SHARMA <[email protected]> Signed-off-by: shubhusion <[email protected]>

Update README.md

6063022

Signed-off-by: SHUBHAM SHARMA <[email protected]> Signed-off-by: shubhusion <[email protected]>

Update README.md

eacd91f

Signed-off-by: SHUBHAM SHARMA <[email protected]> Signed-off-by: shubhusion <[email protected]>

Update README.md

d6259a6

Signed-off-by: SHUBHAM SHARMA <[email protected]> Signed-off-by: shubhusion <[email protected]>

added assets

5749743

Signed-off-by: shubhusion <[email protected]>

added assets

05636ff

Signed-off-by: shubhusion <[email protected]>

Update README.md

2ed1dd7

Signed-off-by: SHUBHAM SHARMA <[email protected]> Signed-off-by: shubhusion <[email protected]>

Update README.md

9db1870

Signed-off-by: SHUBHAM SHARMA <[email protected]> Signed-off-by: shubhusion <[email protected]>

Update README.md

e38fc17

Signed-off-by: SHUBHAM SHARMA <[email protected]> Signed-off-by: shubhusion <[email protected]>

dependabot bot and others added 2 commits July 28, 2024 00:38

Fixed Readme

1ee2d7a

Signed-off-by: shubhusion <[email protected]>

shubhusion force-pushed the develop branch from 6ac7a35 to 1ee2d7a Compare July 27, 2024 19:08

Merge branch 'develop' into develop

3e7c6ce

Signed-off-by: SHUBHAM SHARMA <[email protected]>

shubhusion requested a review from jku August 19, 2024 06:39

jku requested changes Aug 19, 2024

View reviewed changes

jku closed this Oct 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhancing The Update Framework (Python - TUF) README #2655

Enhancing The Update Framework (Python - TUF) README #2655

shubhusion commented Jun 8, 2024 •

edited

Loading

shubhusion commented Jun 9, 2024 •

edited

Loading

jku commented Jun 17, 2024 •

edited

Loading

shubhusion commented Jun 17, 2024

coveralls commented Jun 17, 2024 •

edited

Loading

shubhusion commented Jun 17, 2024

jku left a comment

trishankatdatadog commented Jul 23, 2024

lukpueh commented Jul 24, 2024

shubhusion commented Jul 27, 2024

coveralls commented Jul 29, 2024

jku left a comment

jku Aug 19, 2024

jku commented Oct 22, 2024

Enhancing The Update Framework (Python - TUF) README #2655

Enhancing The Update Framework (Python - TUF) README #2655

Conversation

shubhusion commented Jun 8, 2024 • edited Loading

shubhusion commented Jun 9, 2024 • edited Loading

jku commented Jun 17, 2024 • edited Loading

shubhusion commented Jun 17, 2024

coveralls commented Jun 17, 2024 • edited Loading

Pull Request Test Coverage Report for Build 9544443646

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

shubhusion commented Jun 17, 2024

jku left a comment

Choose a reason for hiding this comment

trishankatdatadog commented Jul 23, 2024

lukpueh commented Jul 24, 2024

shubhusion commented Jul 27, 2024

coveralls commented Jul 29, 2024

Pull Request Test Coverage Report for Build 10125811756

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

jku left a comment

Choose a reason for hiding this comment

jku Aug 19, 2024

Choose a reason for hiding this comment

jku commented Oct 22, 2024

shubhusion commented Jun 8, 2024 •

edited

Loading

shubhusion commented Jun 9, 2024 •

edited

Loading

jku commented Jun 17, 2024 •

edited

Loading

coveralls commented Jun 17, 2024 •

edited

Loading