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

docs: fix README links #2807

Merged
merged 1 commit into from
May 25, 2022
Merged

docs: fix README links #2807

merged 1 commit into from
May 25, 2022

Conversation

kidonng
Copy link
Contributor

@kidonng kidonng commented Mar 20, 2022

Description

Fix some links in README which are either broken or redirected.

If anyone has better place to link to, suggestions welcome.

Checklist

  • Change is backwards compatible.

  • Code formatted with ./format.

  • Code tested through nix-shell --pure tests -A run.all.

  • Test cases updated/added. See example.

  • Commit messages are formatted like

    {component}: {description}
    
    {long description}
    

    See CONTRIBUTING for more information and recent commit messages for examples.

  • If this PR adds a new module

    • Added myself as module maintainer. See example.

    • Added myself and the module files to .github/CODEOWNERS.

@kidonng kidonng requested a review from rycee as a code owner March 20, 2022 05:31
Copy link
Member

@sumnerevans sumnerevans left a comment

Choose a reason for hiding this comment

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

Not sure about the changes to the Nix and Nixpkgs links either. I don't remember what those links used to have.

README.md Show resolved Hide resolved
@kidonng
Copy link
Contributor Author

kidonng commented Mar 21, 2022

Not sure about the changes to the Nix and Nixpkgs links either. I don't remember what those links used to have.

The last present version of Nix and Nixpkgs pages are found on Wayback Machine. The source files of these pages are removed in NixOS/nixos-homepage#453, as a result of NixOS/nixos-homepage#425.

From my understanding:

  • The little info on Nixpkgs page is nuked. The Nixpkgs repository README indeed does not contain all that info, but I wonder if it is that useful for people who aren't familiar with Nix/NixOS.
  • The info on Nix page is consolidated into the index page and "Features" page (which is now the "Explore" page). Since NixOS is already pointing to the index page, the "Explore" page seems to be the only destination what Nix can refer to, just my two cents.

@rycee rycee merged commit 51ea421 into nix-community:master May 25, 2022
@rycee
Copy link
Member

rycee commented May 25, 2022

I think the links you chose are fine and they certainly are much better than broken links. Much appreciated! Merged to master now.

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.

3 participants