Bring over all the Trainings configuration and tools #1141

stevepiercy · 2022-01-16T11:04:41Z

Begin replacing "Trainings" with "Documentation"

See checklist in #1134

- Begin replacing "Trainings" with "Documentation"

netlify · 2022-01-16T11:04:47Z

✔️ Deploy Preview for 6-dev-docs-plone-org ready!

🔨 Explore the source changes: c322350

🔍 Inspect the deploy log: https://app.netlify.com/sites/6-dev-docs-plone-org/deploys/61ebd2d7f28d4f00083f700f

😎 Browse the preview: https://deploy-preview-1141--6-dev-docs-plone-org.netlify.app

stevepiercy · 2022-01-16T11:07:09Z

This is a WIP. I still have a bit more work to do before it is ready for others to start using.

But if you just can't wait, check out this branch and read docs/contributing/setup-build.md for a quick start.

- Update search select menu options - Add another Plone logo version - Blackify

Remove theme-package because it was added out of confusion

Update index for structure Fix Sphinx warnings and errors

ksuess · 2022-01-20T06:28:37Z

make build works quite fine now. It's not even necessary to activate the venv. There's some magic that sphinx-build is found. Try
$ sphinx-build
and
$ which sphinx-build

So you can skip the line
source bin/activate
in setup-build.md

ksuess · 2022-01-20T06:44:30Z

make build works quite fine now. It's not even necessary to activate the venv. There's some magic that sphinx-build is found. Try $ sphinx-build and $ which sphinx-build

So you can skip the line source bin/activate in setup-build.md

It's wrong what I wrote, I did a test from scratch. But I think it's fine now. We can come back to it later.

stevepiercy · 2022-01-20T06:51:33Z

@ksuess, I added one more commit for you to test out. You'll need to run pip install -r requirements then make livehtml.

If it is OK to merge this PR as is, please let me know. I am eager to get something deployed for people to start playing with.

ksuess · 2022-01-20T06:59:12Z

This can be deleted:

.PHONY: test
testlight: clean spellcheck ## Run spellcheck

Move `all` target to the end

stevepiercy · 2022-01-20T07:02:35Z

This can be deleted:

.PHONY: test testlight: clean spellcheck ## Run spellcheck

Good catch! Fixed in 6941292.

ksuess · 2022-01-20T07:08:05Z

make livehtml 😻

ksuess · 2022-01-20T07:09:45Z

Maybe just add a text hint with @echo:

.PHONY: build
build: ## Set up training: Install requirements
python3 -m venv . || virtualenv --clear --python=python3 .
bin/python -m pip install --upgrade pip
bin/pip install -r requirements.txt
@echo
@echo "Please activate your Python virtual environment with"
@echo "source bin/activate"

ksuess · 2022-01-20T07:10:39Z

Let's see what other reviewers find. From me a GO!

ksuess · 2022-01-20T07:14:24Z

make livehtml 😻

I you add

.PHONY: livehtml
livehtml: ## Run live updating build

then make livehtml is shown in the output of make

Add description comment for livehtml when calling `make`

stevepiercy · 2022-01-20T08:32:54Z

I added updates per your comments, but grabbed the description from https://pypi.org/project/sphinx-autobuild/ for make. See 4d035ad

ksuess · 2022-01-20T10:56:25Z

As long as this PR is open: here another little one:
_source folder with txt files could be excluded via robots.txt. Maybe more than this folder…

For example https://61e8de5e50d8f50008c486f8--6-dev-docs-plone-org.netlify.app/_sources/glossary.md.txt

stevepiercy · 2022-01-20T11:14:40Z

I updated the robots.txt, based on what shows up in _build/html/.

stevepiercy · 2022-01-21T10:10:05Z

I'm going to merge this branch after Europeans have had one more day to review it.

I want to announce that 6-dev is ready for everyone to work on before the weekend.

polyester · 2022-01-21T10:24:41Z

.github/workflows/build_deploy.yml

+#        id: deploy
+#        uses: Pendect/action-rsyncer@v1.1.0
+#        env:
+#          DEPLOY_KEY: ${{secrets.DEPLOY_KEY_TRAINING}}


This probably needs a new key

Yup, that's why I commented it out. Who can provide one?

@ericof should be able to do so.

Let's continue the conversion in #1146

polyester · 2022-01-21T10:24:55Z

.github/workflows/build_deploy.yml

+#          options: ''
+#          ssh_options: '-p ${{secrets.DEPLOY_PORT}}'
+#          src: '_build/html/'
+#          dest: '${{secrets.DEPLOY_USER_TRAINING}}@${{secrets.DEPLOY_SERVER_TRAINING}}:${{secrets.DEPLOY_PATH_TRAINING}}/5'


…tation into port-training-config

Bring over all the Trainings configuration and tools

e2f55f0

- Begin replacing "Trainings" with "Documentation"

stevepiercy marked this pull request as draft January 16, 2022 11:05

stevepiercy added 8 commits January 16, 2022 03:10

Use intersphinx link

37582e6

Pin Sphinx minimum version

86e1ef9

- Update search select menu options - Add another Plone logo version - Blackify

Add MyST for labels, clean up English grammar and syntax

153d0ad

Add the backend structure, clean up the index toctree

d4ed5e1

Add missing images, fix reference to static path

487e384

Fix copyright, author, and extra_footer values

c7c0dfc

Remove docs/README-doc-writers.txt as redundant

6cb9e95

Remove obsolete readme

4576039

This was referenced Jan 18, 2022

Fix #23 + README overhaul plone/plone-backend#38

Merged

Plone 6: [dev] Backend / Classic UI #1137

Closed

stevepiercy added 8 commits January 19, 2022 02:42

Add new structure

2a1dceb

Clean up icons.md and whatsnew.md for proper English grammar and syntax

a09e985

Migrate useful content from registry/index into static-resources.md

d5de444

Migrate useful content from registry/index into static-resources.md

92604a7

Rename files and flatten structure one level

9ce117e

Remove theme-package because it was added out of confusion

Merge and resolve differences between the two TTW files

589fee4

Clean up recipes.md, adding labels

dbacd96

Clean up outlines of theming files

64e9f53

Update index for structure Fix Sphinx warnings and errors

stevepiercy marked this pull request as ready for review January 19, 2022 12:38

stevepiercy requested review from ksuess, MrTango, jensens and spereverde January 19, 2022 12:39

stevepiercy added 2 commits January 19, 2022 04:43

Change default option label from Trainings to Documentation

20ba442

Fix title

7247767

stevepiercy requested a review from polyester January 19, 2022 12:52

Try using sphinx-autobuild for live preview

2d3a687

stevepiercy mentioned this pull request Jan 20, 2022

Replace outdated gulp with alternative for live update of local set up #1157

Closed

Remove obsolete test target

6941292

Move `all` target to the end

stevepiercy added 2 commits January 20, 2022 00:26

Replace gulp, yarn, and npm with sphinx-autobuild

835f01a

Add message for build

4d035ad

Add description comment for livehtml when calling `make`

stevepiercy mentioned this pull request Jan 20, 2022

Automate deployment to 6.dev-docs.plone.org #1146

Closed

5 tasks

Update robots.txt

5151432

stevepiercy added 2 commits January 21, 2022 01:54

Use correct name for objects.inv

2c413cf

Don't both ignoring ports on localhost

c917521

fix url

b37d36d

polyester reviewed Jan 21, 2022

View reviewed changes

stevepiercy added 3 commits January 21, 2022 03:25

Remove unnecessary phrase

2307212

Merge branch 'port-training-config' of github.com:stevepiercy/documen…

c4f7501

…tation into port-training-config

Add sphinx-sitemap

c322350

stevepiercy merged commit 127b6ce into plone:6-dev Jan 22, 2022

stevepiercy deleted the port-training-config branch January 22, 2022 10:07

Uh oh!

Bring over all the Trainings configuration and tools #1141

Bring over all the Trainings configuration and tools #1141

Uh oh!

Conversation

stevepiercy commented Jan 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Jan 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stevepiercy commented Jan 16, 2022

Uh oh!

ksuess commented Jan 20, 2022

Uh oh!

ksuess commented Jan 20, 2022

Uh oh!

stevepiercy commented Jan 20, 2022

Uh oh!

ksuess commented Jan 20, 2022

Uh oh!

stevepiercy commented Jan 20, 2022

Uh oh!

ksuess commented Jan 20, 2022

Uh oh!

ksuess commented Jan 20, 2022

Uh oh!

ksuess commented Jan 20, 2022

Uh oh!

ksuess commented Jan 20, 2022

Uh oh!

stevepiercy commented Jan 20, 2022

Uh oh!

ksuess commented Jan 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stevepiercy commented Jan 20, 2022

Uh oh!

stevepiercy commented Jan 21, 2022

Uh oh!

polyester Jan 21, 2022

Choose a reason for hiding this comment

Uh oh!

stevepiercy Jan 21, 2022

Choose a reason for hiding this comment

Uh oh!

polyester Jan 21, 2022

Choose a reason for hiding this comment

Uh oh!

stevepiercy Jan 22, 2022

Choose a reason for hiding this comment

Uh oh!

polyester Jan 21, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stevepiercy commented Jan 16, 2022 •

edited

Loading

netlify bot commented Jan 16, 2022 •

edited

Loading

ksuess commented Jan 20, 2022 •

edited

Loading