Create a Reference Guide with Cookieplone make commands and prompt reference

[stevepiercy]

Links of affected pages in Plone Documentation, if any.

No response

Description

• Create a new page in the yet to be created Reference Guide, "Cookieplone make reference". After generating a full Plone project, you can run make help to get an almost complete list of make commands with help text. We can enhance that output by organizing them or adding context.

• Detailed explanation of what each of the prompts does, where it is not clear from the README.md.

[GOGETASSB23]

Hello @stevepiercy sir,

I'd like to work on this issue and contribute to the Plone documentation. I have already set up the documentation environment and started exploring the make help command.

Could you please assign this issue to me? Also , in order to get the list of make commands can i generate the project using 2nd training(volto-customization using javascript)

Looking forward to your guidance. Thanks!

regards,
Aryan

[stevepiercy]

@GOGETASSB23 thank you for your interest!

We don't assign issues. You can claim them. See Things not to do.

See also Install Plone with Cookieplone, which is the authoritative source for doing just that.

[GOGETASSB23]

@stevepiercy sir, taking into consideration the guidelines to follow the Set up,build and check the quality of documentation, I created a new fork and started over.

I have a doubt regarding the setup. When using mkdocs serve, we add the file to the nav section of mkdocs.yml to reflect changes in the documentation. However, the documentation asks us to use the make livehtml command (Sphinx-autobuild server).

So, according to the suggested documentation, I need to follow make livehtml to run the server. Where do I add the file (cookieplone-make-commands.md) so that it reflects changes on my local server?

this doubt has been solved, thank you..

[stevepiercy]

We don't use mkdocs. We use Sphinx.

make livehtml only watches files that exist at the moment it is launched. You must first create the file, then make livehtml can watch it for changes.

The new file should go in a new directory:

docs/reference/cookieplone-make-commands.md

New files also require a toctree entry, else they do not appear in the sidebar navigation. We will need to add another new file:

docs/reference/index.md

...which will contain the toctree that references the new documentation.

Finally, the primary docs/index.md will need reference/index added to its toctree.