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

[TASK] Introduce Makefile and command 'make docs' #370

Merged
merged 2 commits into from
Jan 21, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ Contributing
Information About Contributing to This Manual
=============================================

Local rendering
---------------

You can render this file locally if you have `Docker <https://www.docker.com/>`
linawolf marked this conversation as resolved.
Show resolved Hide resolved
linawolf marked this conversation as resolved.
Show resolved Hide resolved
and `make <https://www.gnu.org/software/make/>` installed on your local
machine::

make docs
linawolf marked this conversation as resolved.
Show resolved Hide resolved

Create Issues
-------------

Expand All @@ -21,10 +30,10 @@ Make changes (create pull requests)
`rendered page <https://docs.typo3.org/typo3cms/HowToDocument/Index.html>`__,
just click on "Edit me on GitHub".
* Step-by-step walkthrough of making a change by `Editing Directly on GitHub
<https://docs.typo3.org/typo3cms/HowToDocument/WritingDocsOfficial/Index.html>`__
<https://docs.typo3.org/typo3cms/HowToDocument/WritingDocsOfficial/Index.html>`__
(this requires only a browser)
* Step-by-step walkthrough of `Local Editing and Rendering with Docker
<https://docs.typo3.org/typo3cms/HowToDocument/WritingDocsOfficial/LocalEditing.html>`__
<https://docs.typo3.org/typo3cms/HowToDocument/WritingDocsOfficial/LocalEditing.html>`__
(this requires knowledge of Git and Docker)

* See `Writing Documentation <https://docs.typo3.org/typo3cms/HowToDocument/>`__ for further
Expand Down
11 changes: 11 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.PHONY: help
help: ## Displays this list of targets with descriptions
@echo "The following commands are available:\n"
@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}'


.PHONY: docs
docs: ## Generate projects docs (from "Documentation" directory)
mkdir -p Documentation-GENERATED-temp

docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation