Skip to content

Conversation

@mariahynes
Copy link
Contributor

@mariahynes mariahynes commented Oct 27, 2024

Trac ticket number

N/A

Branch description

The users of the django documentation can choose to view certain commands in two different flavours. It is because of this, that the highlighted sentence is not needed on this page https://docs.djangoproject.com/en/dev/intro/contributing/:

The original docs with "If you're using GNU/Linux, macOS, or some other flavor of Unix, run" hgihlighted

This PR removes the highlighted line. Here is the revised section from my local doc build after making this change:

The docs after the update with the line removed

Checklist

  • This PR targets the main branch.
  • The commit message is written in past tense, mentions the ticket number, and ends with a period.
  • I have checked the "Has patch" ticket flag in the Trac system.
  • I have added or updated relevant tests.
  • I have added or updated relevant docs, including release notes if applicable.
  • I have attached screenshots in both light and dark modes for any UI changes.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hello! Thank you for your contribution 💪

As it's your first contribution be sure to check out the patch review checklist.

If you're fixing a ticket from Trac make sure to set the "Has patch" flag and include a link to this PR in the ticket!

If you have any design or process questions then you can ask in the Django forum.

Welcome aboard ⛵️!

Copy link
Member

@pauloxnet pauloxnet left a comment

Choose a reason for hiding this comment

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

Thanks Maria, I think it makes sense. Do you think we can add an alternate text to the images to improve accessibility?

…ng docs.

This is not needed as the console snippet has buttons that allows the user to choose their OS.
Copy link
Contributor

@sarahboyce sarahboyce left a comment

Choose a reason for hiding this comment

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

Thank you @mariahynes - welcome onboard ⛵

@sarahboyce
Copy link
Contributor

Thanks Maria, I think it makes sense. Do you think we can add an alternate text to the images to improve accessibility?

I'm not very good at doing that myself! I added some alt text 👍
I initially wasn't sure if you meant the docs themselves which made me discover the console directive is not very accessible: https://code.djangoproject.com/ticket/35874 (so thank you)

@pauloxnet
Copy link
Member

Thanks Maria, I think it makes sense. Do you think we can add an alternate text to the images to improve accessibility?

I'm not very good at doing that myself! I added some alt text 👍 I initially wasn't sure if you meant the docs themselves which made me discover the console directive is not very accessible: https://code.djangoproject.com/ticket/35874 (so thank you)

Great, more accessibility improvements 👍

@sarahboyce sarahboyce merged commit 163e72e into django:main Oct 29, 2024
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.

3 participants