github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document switch from IRC to GitHub Discussions

Browse source
This commit is contained in:
Justin Mayer 2022-09-15 16:33:19 +02:00
commit 2a7e691000
2 changed files with 13 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

31
CONTRIBUTING.rst
View file

@ -1,11 +1,13 @@
Filing issues
=============
* Before you file an issue, try `asking for help`_ first.
* If determined to file an issue, first check for `existing issues`_, including
closed issues.
* Before you submit a new issue, try `asking for help`_ first.
* If determined to create a new issue, first search `Pelican Discussions`_
and `existing issues`_ (open and closed) to see if your question has already
been answered previously.
.. _`asking for help`: `How to get help`_
.. _`Pelican Discussions`: https://github.com/getpelican/pelican/discussions
.. _`existing issues`: https://github.com/getpelican/pelican/issues
How to get help
@ -64,26 +66,10 @@ publicly-accessible location:
the ``--debug`` flag: ``pelican --debug content [...]``)
.. _documentation: https://docs.getpelican.com/
.. _`paste service`: https://dpaste.de/
Once the above preparation is ready, you can contact people willing to help via
(preferably) the ``#pelican`` IRC channel or send a message to ``authors at getpelican dot com``.
Remember to include all the information you prepared.
The #pelican IRC channel
------------------------
* Because of differing time zones, you may not get an immediate response to your
question, but please be patient and stay logged into IRC — someone will almost
always respond if you wait long enough (it may take a few hours).
* If you don't have an IRC client handy, use the webchat_.
* You can direct your IRC client to the channel using this `IRC link`_ or you
can manually join the ``#pelican`` IRC channel on the `freenode IRC network`_.
.. _webchat: https://kiwiirc.com/client/irc.freenode.net/?#pelican
.. _`IRC link`: irc://irc.freenode.net/pelican
.. _`freenode IRC network`: https://freenode.net/
.. _`paste service`: https://dpaste.com
Once the above preparation is ready, you can post your query as a new thread in
`Pelican Discussions`_. Remember to include all the information you prepared.
Contributing code
=================
@ -153,7 +139,6 @@ Check out our `Git Tips`_ page or `ask for help`_ if you
need assistance or have any questions about these guidelines.
.. _`plugin`: https://docs.getpelican.com/en/latest/plugins.html
.. _`#pelican IRC channel`: https://webchat.freenode.net/?channels=pelican&uio=d4
.. _`Create a new git branch`: https://github.com/getpelican/pelican/wiki/Git-Tips#making-your-changes
.. _`Squash your commits`: https://github.com/getpelican/pelican/wiki/Git-Tips#squashing-commits
.. _`Run all the tests`: https://docs.getpelican.com/en/latest/contribute.html#running-the-test-suite

10
docs/faq.rst
View file

@ -11,11 +11,11 @@ Please read our :doc:`feedback guidelines <contribute>`.
How can I help?
===============
There are several ways to help out. First, you can report any Pelican
suggestions or problems you might have via IRC (preferred) or the `issue
tracker <https://github.com/getpelican/pelican/issues>`_. If submitting an
issue report, please first check the existing issue list (both open and closed)
in order to avoid submitting a duplicate issue.
There are several ways to help out. First, you can communicate any Pelican
suggestions or problems you might have via `Pelican Discussions
<https://github.com/getpelican/pelican/discussions>`_. Please first check the
existing list of discussions and issues (both open and closed) in order to
avoid submitting topics that have already been covered before.
If you want to contribute, please fork `the git repository
<https://github.com/getpelican/pelican/>`_, create a new feature branch, make