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.

Sign up for GitHub

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

Jump to bottom

Update contact instructions: announce chat, preference for issues #2610

Merged
merged 2 commits into from Oct 11, 2021
Merged

Update contact instructions: announce chat, preference for issues #2610

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f736e9
Update contact instructions: announce chat, preference for issues
oprypin Oct 10, 2021
a263bda
Fix mistake in sentence
oprypin Oct 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 12 additions & 4 deletions README.md
View file
Open in desktop
Expand Up @@ -27,11 +27,18 @@ user guide.

If you need help with MkDocs, do not hesitate to get in contact with us!

You can either open a [Discussion] to ask questions or create an [Issue] to
report a bug or make a feature request. Please note that we may only provide
- For questions and high-level discussions, use **[Discussions]** on GitHub.
- For small questions, a good alternative is the **[Chat room]** on
Gitter/Matrix (**new!**)
Copy link
Member

Choose a reason for hiding this comment

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

I usually refrain from using "new" term since it implies that somehow someday this will not be new. But when is that time? Will we remember to remove it? See what I mean...

But this is trivial questioning so np

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree on this one. Having a "New" indicator always adds the extra work of removing it at one point in the future and it isn't really clear when this should be.

The text wouldn't really change without the "new" text so I would vote for removing it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, I'm just going to disagree there. I want to bring attention to it. And I am not scared to take up the task of removing the "new" eventually.

Copy link
Contributor

Choose a reason for hiding this comment

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

I mean, people aren't that dumb to not notice a new place to communicate. You could also make like a discussion post announcing this.
And adding a "NEW!" label to this feels like all those companies trying to get you to pay for their "new" product/service. Like a desperate attempt of getting people to join this place.

Copy link
Member

Choose a reason for hiding this comment

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

I'm fine with leaving it @oprypin sure.

But since our intention is to shed a light on this new communication channel, it may be worth mentioning it on the release notes #2614 ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will mention it on the GitHub release, but haven't decided about release notes on the site

- To report a bug or make a feature request, open an **[Issue]** on GitHub.

Please note that we may only provide
support for problems/questions regarding core features of MkDocs. Any
questions or bug reports about features of third-party themes, plugins,
extensions or similar should be made to their respective projects.
extensions or similar should be made to their respective projects.
But, such questions are *not* banned from the [chat room].

Make sure to stick around to answer some questions as well!

## Links

Expand Down Expand Up @@ -60,7 +67,8 @@ discussion forums is expected to follow the [PyPA Code of Conduct].
<!-- Links -->
[mkdocs]: https://www.mkdocs.org
[Issue]: https://github.com/mkdocs/mkdocs/issues
[Discussion]: https://github.com/mkdocs/mkdocs/discussions
[Discussions]: https://github.com/mkdocs/mkdocs/discussions
[Chat room]: https://gitter.im/mkdocs/community
[release-notes]: https://www.mkdocs.org/about/release-notes/
[wiki]: https://github.com/mkdocs/mkdocs/wiki
[Contributing Guide]: https://www.mkdocs.org/about/contributing/
Expand Down
5 changes: 4 additions & 1 deletion docs/about/contributing.md
View file
Open in desktop
Expand Up @@ -70,7 +70,10 @@ Themes]. We welcome translation Pull Requests!

## Submitting Pull Requests

Once you are happy with your changes or you are ready for some feedback, push
If you're considering a large code contribution to MkDocs, please prefer to
open an issue first to get early feedback on the idea.

Once you think the code is ready to be reviewed, push
it to your fork and send a pull request. For a change to be accepted it will
most likely need to have tests and documentation if it is a new feature.

Expand Down