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

Progressive galib/update readme.rst #2170

Conversation

progressive-galib
Copy link
Contributor

I revised the readme.rst file to accurately reflect that the repository pertains to DNF4, addressing potential confusion with latest dnf by adding a notice and a link directing users to the repository for DNF5.

These changes aim to improve documentation clarity and user navigation. This update resolves issue [#2154](#2154) .

= changelog =
msg: Updated readme.rst to clarify that the repository is for DNF4 and included a link to the latest DNF5 repository.
type: enhancement
resolves: #2154
related: #2154

README.rst Outdated
###############

==================================================================================================================================================================================================
⚠️ **Notice:** This repository is for **DNF4** only For the current DNF version (DNF5), visit `https://github.com/rpm-software-management/dnf5`
Copy link

Choose a reason for hiding this comment

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

I think there is a period missing between "only For"

Copy link

Choose a reason for hiding this comment

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

Also the link looks a bit odd here, maybe shorten the link text to rpm-software-management/dnf5 or rephrase it compeletely, e.g. "The current DNF version is DNF 5." or "The current DNF version 5 has its own repository" (With the ticked words as the same link of course.)

But these are just suggestions to make it look nicer, your current PR would also be good enough for me.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

english is not my first language can you rewrite that bit for me ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

english is not my first language can you rewrite that bit for me ?

ohh i see the mistake now, no need to write, i am doing it myself


.. image:: https://raw.githubusercontent.com/rpm-software-management/dnf/gh-pages/logos/DNF_logo.png

Dandified YUM (DNF) is the next upcoming major version of `YUM <http://yum.baseurl.org/>`_. It does package management using `RPM <http://rpm.org/>`_, `libsolv <https://github.com/openSUSE/libsolv>`_ and `hawkey <https://github.com/rpm-software-management/hawkey>`_ libraries. For metadata handling and package downloads it utilizes `librepo <https://github.com/tojaj/librepo>`_. To process and effectively handle the comps data it uses `libcomps <https://github.com/midnightercz/libcomps>`_.
Copy link

Choose a reason for hiding this comment

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

This was quite outdated, good catch!

progressive-galib added a commit to progressive-galib/dnf that referenced this pull request Dec 10, 2024
@progressive-galib
Copy link
Contributor Author

#2170 (comment)

done

Copy link

@dreua dreua left a comment

Choose a reason for hiding this comment

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

Look great to me, thanks! But I am not a maintainer / reviewer for this project, so hopefully they will agree and merge this 😉

README.rst Outdated Show resolved Hide resolved
@kontura kontura self-assigned this Dec 16, 2024
@kontura
Copy link
Contributor

kontura commented Dec 19, 2024

Oh, one more thing, I just noticed its 7 commits, could I please ask you to squash them into just one?

@dreua
Copy link

dreua commented Dec 19, 2024

I wouldn't expect anyone else to work on this feature branch so you can do the squashing yourself. I usually use the following but there are probably other ways:

git rebase -i master  #will open a text editor with a commit list and short explanation of the options
git push --force-with-lease  # allow overwriting on the remote (only if it hasn't change since your last pull to be on the safe side)

Update README.rst 2

msg: Updated `readme.rst` to clarify that the repository is for DNF4 and included a link to the latest DNF5 repository. type: enhancement resolves: rpm-software-management#2154 related: rpm-software-management#2153

msg: Updated `readme.rst` to clarify that the repository is for DNF4 and included a link to the latest DNF5 repository.
type: enhancement
resolves: rpm-software-management#2154
related: rpm-software-management#2153

msg: Updated `readme.rst` to clarify that the repository is for DNF4 and included a link to the latest DNF5 repository. type: enhancement resolves: rpm-software-management#2154 related: rpm-software-management#2153

msg: Updated `readme.rst` to clarify that the repository is for DNF4 and included a link to the latest DNF5 repository.
type: enhancement
resolves: rpm-software-management#2154
related: rpm-software-management#2153

Update README.rst

done suggestion rpm-software-management#2170 (comment)

fixed rst syntax mistake

Update README.rst to remove grammar mistake

https://github.com/rpm-software-management/dnf/pull/2170/files/5e2eea9471d811ef75ffd6e8a245046e155010cb#r1886386912
@progressive-galib progressive-galib force-pushed the progressive-galib/update-readme.rst branch from cf8eb2a to fe29c8c Compare December 19, 2024 13:51
@progressive-galib
Copy link
Contributor Author

Oh, one more thing, I just noticed its 7 commits, could I please ask you to squash them into just one?

done

@kontura
Copy link
Contributor

kontura commented Dec 19, 2024

Thank you!

@kontura kontura merged commit e44e98a into rpm-software-management:master Dec 19, 2024
4 of 7 checks passed
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 this pull request may close these issues.

This repo seems to be dnf4 only
3 participants