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

Fix Inconsistent URL Format in Getting Started tutorial #11009

Merged
merged 2 commits into from
Oct 9, 2023

Conversation

codewithmide
Copy link
Contributor

Fixes #11007

Description:

In this pull request, I address issue #11007, which relates to the inconsistent usage of URLs in the Wagtail documentation.

Changes Made:

I've standardized the URL format used throughout the documentation to consistently use "http://localhost:8000/" instead of "http://127.0.0.1:8000/". This change improves the clarity and user experience for individuals setting up a local development environment while following the documentation.

Please check the following:

  • Do the tests still pass?[^1]
  • Does the code comply with the style guide?
    • Run make lint from the Wagtail root.
  • For Python changes: Have you added tests to cover the new/fixed behaviour?
  • For front-end changes: Did you test on all of Wagtail’s supported environments?[^2]
    • Please list the exact browser and operating system versions you tested:
    • Please list which assistive technologies [^3] you tested:
  • For new features: Has the documentation been updated accordingly?

@squash-labs
Copy link

squash-labs bot commented Oct 6, 2023

Manage this branch in Squash

Test this branch here: https://codewithmidelocalhost-2mzfu.squash.io

Copy link
Member

@thibaudcolas thibaudcolas left a comment

Choose a reason for hiding this comment

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

Thanks for giving this a go @codewithmide. As far as I can see there was only one inconsistency where we use localhost instead of 127.0.0.1. I’d prefer we change that one spot rather than everything else, unless we have a good reason?

I believe we chose 127.0.0.1 because that’s what the runserver command we use displays in its output.

@thibaudcolas thibaudcolas added Outreachy https://www.wagtail.org/outreachy/ Documentation status:Needs Work labels Oct 6, 2023
@codewithmide
Copy link
Contributor Author

Thanks for giving this a go @codewithmide. As far as I can see there was only one inconsistency where we use localhost instead of 127.0.0.1. I’d prefer we change that one spot rather than everything else, unless we have a good reason?

I believe we chose 127.0.0.1 because that’s what the runserver command we use displays in its output.

Yeah that's true, I have made the change now. Thank you for the correction.

@gasman gasman mentioned this pull request Oct 8, 2023
Copy link
Member

@thibaudcolas thibaudcolas left a comment

Choose a reason for hiding this comment

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

Nice one @codewithmide!

@thibaudcolas thibaudcolas changed the title Fix Inconsistent URL Format in Documentation Fix Inconsistent URL Format in Getting Started tutorial Oct 9, 2023
@thibaudcolas thibaudcolas merged commit 5ab5540 into wagtail:main Oct 9, 2023
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Outreachy https://www.wagtail.org/outreachy/
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consistent Usage of URLs
2 participants