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

docs: update faq with new questions, fix menus #5924

Merged
merged 11 commits into from Mar 4, 2024
Merged

Conversation

rfay
Copy link
Member

@rfay rfay commented Mar 3, 2024

The Issue

Noticed FAQs that people ask... about code and DDEV, about where the databases live.

How This PR Solves The Issue

  • Minor change to make mkdocs-serve - delete the container on exit
  • Fix menus on hosting provider integration. They've been messed up forever
  • Add new FAQs

Manual Testing Instructions

Built docs at https://ddev--5924.org.readthedocs.build/en/5924/users/usage/faq/

  • Review "hosting provider integration" and related menus at
  • Review FAQ

Notes

For the mkdocs-not-installed case make mkdocs-serve provides a docker-based mkdocs setup thanks to @tyler36

The polinux/mkdocs docker image has moved along, and now has arm64 version (not pushed properly), but the current image does not seem to work right on either arm64 or amd64.

I experimented with this, though, to handle arm64, but neither the amd64 nor arm64 images worked right with 1.5.2, so I gave up:

mkdocs-serve:
	$(shell if command -v mkdocsx >/dev/null ; then \
			mkdocs serve; \
		else \
			TAG=1.5.2; \
			set -x; \
			if [ $(BUILD_ARCH) = 'arm64' ]; then TAG="arm64v8-$${TAG}"; fi; \
			docker run -it --rm -v "${PWD}:/docs" -p 8000:8000 -e "ADD_MODULES=mkdocs-material mkdocs-redirects mkdocs-minify-plugin mdx_truly_sane_lists mkdocs-git-revision-date-localized-plugin" -e "LIVE_RELOAD_SUPPORT=true" -e "FAST_MODE=true" -e "DOCS_DIRECTORY=./docs" polinux/mkdocs:$${TAG}; \
			set +x; \
		fi \
	)

@rfay rfay changed the title 20240303 faq docs: update faq with new questions, fix menus Mar 3, 2024
Copy link

github-actions bot commented Mar 3, 2024

@rfay rfay requested a review from rpkoller March 3, 2024 18:19
@rfay rfay marked this pull request as ready for review March 4, 2024 01:34
@rfay rfay requested review from a team as code owners March 4, 2024 01:34
@rfay rfay requested a review from stasadev March 4, 2024 03:24
Copy link
Collaborator

@rpkoller rpkoller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few comments and thoughts. Overall that looks great!

docs/content/users/providers/index.md Outdated Show resolved Hide resolved
docs/content/users/topics/index.md Outdated Show resolved Hide resolved
docs/content/users/usage/faq.md Outdated Show resolved Hide resolved
docs/content/users/usage/faq.md Outdated Show resolved Hide resolved
rfay and others added 2 commits March 4, 2024 07:26
Co-authored-by: Ralf Koller <1665422+rpkoller@users.noreply.github.com>
@rfay rfay merged commit d4fc865 into ddev:master Mar 4, 2024
9 checks passed
@rfay rfay deleted the 20240303_faq branch March 4, 2024 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants