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

Docs: Contact plugin/theme maintainers for those issues

Browse source
This commit is contained in:
Justin Mayer 2022-08-21 08:57:07 +02:00
commit 09d434d87b
1 changed files with 10 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

15
CONTRIBUTING.rst
View file

@ -26,16 +26,21 @@ Before you ask for help, please make sure you do the following:
* latest releases of libraries used by Pelican * latest releases of libraries used by Pelican
* no plugins or only those related to the issue * no plugins or only those related to the issue
**NOTE:** The most common sources of problems are anomalies in (1) themes, **NOTE:** The most common sources of problems are anomalies in (1) themes, (2)
(2) settings files, and (3) ``make``/``invoke`` automation wrappers. If you can't plugins, (3) settings files, and (4) ``make``/``invoke`` automation wrappers.
reproduce your problem when using the following steps to generate your site, If you can't reproduce your problem when using the following steps to generate
then the problem is almost certainly with your chosen theme and/or settings your site, then the problem is almost certainly with one of the above-listed
file (and not Pelican itself):: elements (and not Pelican itself)::
cd ~/projects/your-site cd ~/projects/your-site
git clone https://github.com/getpelican/pelican ~/projects/pelican git clone https://github.com/getpelican/pelican ~/projects/pelican
pelican content -s ~/projects/pelican/samples/pelican.conf.py -t ~/projects/pelican/pelican/themes/notmyidea pelican content -s ~/projects/pelican/samples/pelican.conf.py -t ~/projects/pelican/pelican/themes/notmyidea
If you can generate your site without problems using the steps above, then your
problem is unlikely to be caused by Pelican itself, and therefore please
consider reaching out to the maintainers of the plugins/theme you are using
instead of raising the topic with the Pelican core community.
If despite the above efforts you still cannot resolve your problem, be sure to If despite the above efforts you still cannot resolve your problem, be sure to
include in your inquiry the following information, preferably in the form of include in your inquiry the following information, preferably in the form of
links to content uploaded to a `paste service`_, GitHub repository, or other links to content uploaded to a `paste service`_, GitHub repository, or other