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

Move the adopters' companies list to a separate file/page #4291

Merged
merged 6 commits into from
Sep 9, 2022

Conversation

danicheg
Copy link
Member

@danicheg danicheg commented Sep 9, 2022

I want to thin the readme/index page of the website a little. The adopters' companies list could be located on a separate file/page harmless.

Copy link
Member

@armanbilge armanbilge left a comment

Choose a reason for hiding this comment

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

👍

ADOPTERS.md Show resolved Hide resolved
@@ -1 +0,0 @@
../README.md
Copy link
Member Author

Choose a reason for hiding this comment

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

We have to create a dedicated index.md file to have a proper link to the website page and not to Github.

Copy link
Member Author

Choose a reason for hiding this comment

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

Also, this file is basically a copy-paste of the current README.md besides the 'documentation' paragraph. It's odd a little to have this paragraph when we have the bar with those links on every page.

Copy link
Member

@armanbilge armanbilge left a comment

Choose a reason for hiding this comment

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

Thanks!

- [XITE](https://xite.com/)
- [Zalando](https://zalando.com)
- [Zendesk](https://www.zendesk.com)
A (non-exhaustive) list of companies that use Cats in production is featured in [ADOPTERS.md](./ADOPTERS.md). Don't see yours? [You can add it in a PR!](https://github.com/typelevel/cats/edit/main/ADOPTERS.md) And if you can, consider [supporting us](https://opencollective.com/typelevel).
Copy link
Member

Choose a reason for hiding this comment

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

Is this [ADOPTERS.md](./ADOPTERS.md) the reason we are duplicating the readme? I think it would be fine to link to the website for both. It would have to be be an absolute URL.

But I'm also favor of the readme and index eventually becoming separate anyway, so might as well happen now.

Copy link
Member Author

Choose a reason for hiding this comment

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

I also deleted the 'documentation' paragraph in the index page source. So they differ not only by the link already :)

@danicheg danicheg merged commit 6be9fd2 into typelevel:main Sep 9, 2022
@danicheg danicheg deleted the adopters branch September 9, 2022 21:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants