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: fix order of events in zola overview (templates, server, content) #2574

Merged

Conversation

iamorphen
Copy link
Contributor

@iamorphen iamorphen commented Jul 15, 2024

Introduction

Fixes #2441 . This change targets master since it's a documentation fix.

Documentation changes

  1. Base overview (and linked installation instructions) on zola 0.19.1 (bumped from 0.17.1). Please note that I did not check all installation routines for correctness.
  2. Move creation of all templates first, then start the development server, then create site content.
  3. Reword sections in the template portion to allude to details to come in the content portion. The documentation previously grouped individual templates with content using such templates.
  4. Remove bash from code blocks that are not shell script source code.
  5. Make some long lines in code blocks shorter to remove the need for readers to scroll horizontally.

@iamorphen iamorphen force-pushed the docs/orphen/fix-zola-overview-order-of-events branch from 5831514 to 5a720cb Compare July 15, 2024 11:12
@iamorphen iamorphen marked this pull request as ready for review July 15, 2024 11:12
@iamorphen
Copy link
Contributor Author

@Keats , I got a little carried away and made some other stylistic changes (line length, bash stuff, noted in the description). If it's better I leave those out, I'm happy to do so. Thanks always!

@Keats Keats merged commit 6390f65 into getzola:master Jul 15, 2024
7 checks passed
@Keats
Copy link
Collaborator

Keats commented Jul 15, 2024

Thanks!

@iamorphen
Copy link
Contributor Author

Thanks for your time!

@iamorphen iamorphen deleted the docs/orphen/fix-zola-overview-order-of-events branch July 16, 2024 09:29
berdandy pushed a commit to berdandy/azola that referenced this pull request Sep 17, 2024
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.

0.18.0 zola serve requires restart to complete Getting Started Overview
2 participants