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: rename form checks page to "Checks / radios" #31090

Merged
merged 9 commits into from Jun 27, 2020
Merged

Conversation

patrickhlauke
Copy link
Member

@patrickhlauke patrickhlauke commented Jun 18, 2020

it's not immediately obvious that "checks" includes information about both checkboxes and radio buttons. while "checks / radios" is also still not perfect (as honestly even I didn't quite grok that "checks" meant checkboxes), it should make it slightly more obvious nonetheless

Preview: https://deploy-preview-31090--twbs-bootstrap.netlify.app/docs/5.0/forms/checks-radios/

it's not immediately obvious that "checks" includes information about both checkboxes and radio buttons. while "checks / radios" is also still not perfect (as honestly even I didn't quite grok that "checks" meant checkboxes), it should make it slightly more obvious nonetheless
@patrickhlauke
Copy link
Member Author

(btw not sure if there's anything more that needs to be done for such a fundamental restructure...forgive my naive approach here)

@MartijnCuppens
Copy link
Member

I'm also in favor of renaming checks to checkboxes (and also .form-check to form-checkbox). Maybe we should also rename .form-check[type="radio"] to .form-radio (could be covered in another PR).

Btw, the link in the sidemenu is broken in this PR

@patrickhlauke
Copy link
Member Author

Btw, the link in the sidemenu is broken in this PR

I wasn't sure how to resolve this in terms of having it shorter in the sidebar ("Checks / radios") but still have the title longer on the page itself ("Checks and radios"). I tried to work out how the "Browsers & devices"/"Browsers and devices" page does it, but to no avail.

I think the other changes (actually changing the classnames etc) may be a bit more fundamental...in this PR I'm really just after some clarity for the docs themselves, as it's unintuitive that "Checks" covers both checkboxes and radio buttons (though yes, they still use the same classname)

@mdo
Copy link
Member

mdo commented Jun 18, 2020

I'd like to leave the class name as-is to keep v4 and v5 close. Every rename means more work for folks to upgrade. I'm okay to change the name of the page, though.

@patrickhlauke
Copy link
Member Author

any clue on how to end up with having the link in the sidebar say "Checks / radios", the URL be checks-radios, the title in full be "Checks and radios"? (similar to what "Browsers & devices" does)

am i missing some key location/file that helps with this mapping/connection?

@MartijnCuppens
Copy link
Member

@mdo

I'd like to leave the class name as-is to keep v4 and v5 close.

In v4, those controls were named .custom-checkbox and .custom-radio. The change to .form-checkbox and .form-radio would be easier I guess.

@patrickhlauke

am i missing some key location/file that helps with this mapping/connection?

Hugo's urlize function is used as "mapping"

{{- $link_slug := $link | urlize -}}

see if "&" works better than "/" (without need for further tweaks)
@patrickhlauke
Copy link
Member Author

while not a fan, i've fixed it by using & rather than / in sidebar.yml

@patrickhlauke
Copy link
Member Author

any clue why the two checks for Docs keep failing for this PR?

@ffoodd
Copy link
Member

ffoodd commented Jun 19, 2020

@patrickhlauke There's a link somewhere pointing to /form/checks, resulting in a 404 error. That's why it rails, currently.

@patrickhlauke
Copy link
Member Author

@ffoodd aha, it helps when i look at the actual details for the "docs (pull_request)" (as the "docs (push)" one was just cryptic). found it...

@patrickhlauke patrickhlauke added this to Inbox in v5.0.0-alpha2 via automation Jun 21, 2020
v5.0.0-alpha2 automation moved this from Inbox to Approved Jun 27, 2020
@XhmikosR XhmikosR merged commit 490acf6 into main Jun 27, 2020
v5.0.0-alpha2 automation moved this from Approved to Shipped Jun 27, 2020
@XhmikosR XhmikosR deleted the v5-docs-rename-checks branch June 27, 2020 18:32
olsza pushed a commit to olsza/bootstrap that referenced this pull request Oct 3, 2020
* Docs: rename form checks page to "Checks / radios"

it's not immediately obvious that "checks" includes information about both checkboxes and radio buttons. while "checks / radios" is also still not perfect (as honestly even I didn't quite grok that "checks" meant checkboxes), it should make it slightly more obvious nonetheless
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
v5.0.0-alpha2
  
Shipped
Development

Successfully merging this pull request may close these issues.

None yet

5 participants