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

Smaller improvements to the README #652

Merged
merged 27 commits into from Dec 2, 2020
Merged

Smaller improvements to the README #652

merged 27 commits into from Dec 2, 2020

Conversation

garbas
Copy link
Member

@garbas garbas commented Nov 27, 2020

and some smaller improvements to the README

This change is Reviewable

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@garbas garbas requested a review from samueldr November 27, 2020 15:18
@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@garbas garbas mentioned this pull request Nov 30, 2020
@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

Copy link
Member

@samueldr samueldr left a comment

Choose a reason for hiding this comment

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

Some nit picks, some weird english formulation. And a request that I don't think will be handled.

Otherwise good idea.

README.md Outdated Show resolved Hide resolved
run.py 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
flake.nix Show resolved Hide resolved
flake.nix Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
Co-authored-by: Samuel Dionne-Riel <samuel@dionne-riel.com>
@samueldr
Copy link
Member

samueldr commented Nov 30, 2020

In addition to the review, I will formally add that I don't like embracing a third-party service as part of the official presentation and documentation of the project. I'm talking about gitpod.

While yes, they allow self-hosting, adding it that way to the README and the project adds tacit approval from the organization to that service.

Co-authored-by: Samuel Dionne-Riel <samuel@dionne-riel.com>
garbas and others added 3 commits November 30, 2020 23:58
Co-authored-by: Samuel Dionne-Riel <samuel@dionne-riel.com>
Co-authored-by: Samuel Dionne-Riel <samuel@dionne-riel.com>
Co-authored-by: Samuel Dionne-Riel <samuel@dionne-riel.com>
@github-actions
Copy link
Contributor

garbas and others added 2 commits December 1, 2020 00:00
Co-authored-by: Samuel Dionne-Riel <samuel@dionne-riel.com>
Co-authored-by: Samuel Dionne-Riel <samuel@dionne-riel.com>
@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@garbas
Copy link
Member Author

garbas commented Nov 30, 2020

I've address all the comments and suggestions.

In addition to the review, I will formally add that I don't like embracing a third-party service as part of the official presentation and documentation of the project. I'm talking about gitpod.

While yes, they allow self-hosting, adding it that way to the README and the project adds tacit approval from the organization to that service.

Personally I don't think having a GitPod link in readme adds any approval from the organization. I would like more contributions and if that means we will add more configuration for services that help contributors of nixos-homepage, then I don't see why not.

But there is a big difference when adding this links and promoting this tools and services on the nixos.org or other subdomains.

We should use all the help internet can provide in order to attract more contributions to nixos-homepage.

@edolstra
Copy link
Member

edolstra commented Dec 1, 2020

I'm not in favor of adding a dependency on yet another proprietary service, especially when it should be unnecessary. Building the homepage should require nothing more than running nix build.

Personally I don't think having a GitPod link in readme adds any approval from the organization.

I think that's a bit naive. From the Gitpod homepage: "Describe your dev environments as code". That's exactly what Nix purports to do, so the fact that we're relying on Gitpod undercuts the argument for using Nix.

@garbas
Copy link
Member Author

garbas commented Dec 2, 2020

I'm not in favor of adding a dependency on yet another proprietary service, especially when it should be unnecessary. Building the homepage should require nothing more than running nix build.

If this would be the case then I wouldn't be trying to convince you to add this button.

Personally I don't think having a GitPod link in readme adds any approval from the organization.

I think that's a bit naive. From the Gitpod homepage: "Describe your dev environments as code". That's exactly what Nix purports to do, so the fact that we're relying on Gitpod undercuts the argument for using Nix.

I don't think relying on GitPod undercuts the argument for using Nix. Then we could use the same argument for Docker or even AWS. Nix works alongside Docker and AWS and improves the experience. This is the same for Gitpod.

Just to move further I will remove this link and configuration, but I hope to discuss this at the next marketing meeting. Eg. why do we provide links to AWS and not to other services. Just to define what are the guidelines and what are the policies.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 2, 2020

@garbas garbas merged commit d193d88 into master Dec 2, 2020
@garbas garbas deleted the improve-readme branch December 2, 2020 14:00
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.

None yet

3 participants