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

Added reference guide for cookieplone-make-commands #1861

Closed

Conversation

GOGETASSB23
Copy link

@GOGETASSB23 GOGETASSB23 commented Feb 14, 2025

This PR adds a new Reference Guide for Cookieplone make commands under the docs/reference-guide/ section. It documents various make commands used in Cookieplone and organizes them by category.

Changes Introduced:

Added: docs/reference-guide/cookieplone-make-commands.md

Categorized make commands into Frontend, Backend, Docker, and Utility Commands.

Provides descriptions for each command.

Added: docs/reference-guide/index.md

Introduces the Reference Guide section.

Modified: docs/index.md

Added a link to the Reference Guide so users can navigate to it easily.


📚 Documentation preview 📚: https://plone6--1861.org.readthedocs.build/

@GOGETASSB23
Copy link
Author

@stevepiercy sir, can you please let me know why the tests failed?

@stevepiercy
Copy link
Contributor

@stevepiercy sir, can you please let me know why the tests failed?

When I click the failing check's link, I see this:

https://github.com/plone/documentation/actions/runs/13335555887/job/37249827929?pr=1861

(volto/blocks/block-style-wrapper: line 224) redirect https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties - permanently to https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_cascading_variables/Using_CSS_custom_properties

That's our linkchecker, telling us that Mozilla moved this file. That needs to be done in a separate PR, per https://6.docs.plone.org/contributing/documentation/index.html#documentation-repositories.

@GOGETASSB23
Copy link
Author

@stevepiercy sir, how should I update the outdated Mozilla link to avoid test errors? I initially fixed it by updating the file containing the link (submodules/volto/docs/source/blocks/block-style-wrapper.md), but I was advised not to commit submodules. What would be the correct approach to resolve this issue?

@stevepiercy
Copy link
Contributor

I don't think you understand what is a git submodule. It is not the content within a directory named submodules.

See Contribute to documentation for how to proceed, especially Editing external package documentation.

@stevepiercy
Copy link
Contributor

The content in this PR has superfluous formatting, unnecessary emojis, and invalid MyST markup. It is actually worse than issuing the command make help. I can't accept it, much less give this a helpful or constructive review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants