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: 12-factor tutorial maintenance #2220

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

erinecon
Copy link
Contributor

Overview

Mostly directory-related maintenance work spanning across all four 12-factor tutorials.

Summary of changes

  • The "What you'll do" sections are now numbered lists.
  • Any mention of the root directory (e.g., /django-hello-world) now contains a tilde in front (e.g., ~/django-hello-world).
  • Captions on full code examples now contain captions with explicit reference to the full path (e.g., app.py is now ~/flask-hello-world/app.py). This change did not affect snippets of YAML files, which contain no caption whatsoever.
  • Some mentions of visitors_app.py were renamed to app.py as the visitors_app.py naming was due to the multiple Python files needed for the spread tests.

@@ -544,7 +544,7 @@ In this iteration, we'll add a greeting app that returns a ``Hello, world!`` gre
The generated Django app doesn't come with an app, which is why
we had to initially enable debug mode for testing. We will need to go back
out to the ``~/django-hello-world`` directory where the rock is and enter
into the ``/django_hello_world`` directory where the Django app
into the ``./django_hello_world`` directory where the Django app
Copy link
Contributor

Choose a reason for hiding this comment

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

FWIW, for me, relative vs. absolute pathing doesn't aid in understanding the folder structure. My confusion comes from having two dirs with the same name differentiated by punctuation, one nested in the other.

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