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

chore(macros/HTTPSidebar): Reorg HTTP sidebar after doc reshuffle, delete 'Basics of HTTP' #11753

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

Conversation

bsmth
Copy link
Member

@bsmth bsmth commented Sep 6, 2024

Summary

This PR reorganizes the HTTP sidebar after a reshuffle and reorg of docs under HTTP.

⚠️ dependencies: ⚠️

Should be merged after:

Problem

'Basics of HTTP' doc is proposed deletion. The index also surfaces some guides that are hidden further down the tree.

Solution

Restructure the HTTP sidebar to better reflect IA of HTTP section.

Screenshots

Before

image


image

After

image

image

How did you test this change?

@bsmth bsmth requested a review from a team as a code owner September 6, 2024 15:44
@github-actions github-actions bot added the macros tracking issues related to kumascript macros label Sep 6, 2024
@Josh-Cena
Copy link
Member

Josh-Cena commented Sep 6, 2024

  1. I think there should be a single link to the whole "URI" doc instead of many. WDYT?
  2. https://jc-verse.github.io/mdn-graph/warnings reports a few other unreachable pages. Not sure if you want to add them too.

@bsmth bsmth marked this pull request as draft September 7, 2024 10:07
@bsmth
Copy link
Member Author

bsmth commented Sep 9, 2024

  1. I think there should be a single link to the whole "URI" doc instead of many. WDYT?

I'll take a look how this appears, but I think you are probably right.

https://jc-verse.github.io/mdn-graph/warnings reports a few other unreachable pages. Not sure if you want to add them too.

Very convenient, ty. I think these should be in there as long as they live in this directory (Ogg guide may be a candidate to be moved out to https://developer.mozilla.org/en-US/docs/Web/Media but not for now.)

Comment on lines +318 to +329
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Overview`, null, text['Overview'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Messages`, null, text['Messages'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Headers`, null, text['Headers'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Methods`, null, text['Methods'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Status`, null, text['Status'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Session`, null, text['Session'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Compression`, null, text['Compression'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Content_negotiation`, null, text['ContentNego'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Proxy_servers_and_tunneling`, null, text['Proxies'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Connection_management_in_HTTP_1.x`, null, text['Connection1x'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Protocol_upgrade_mechanism`, null, text['ProtocolUpgradeMech'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Evolution_of_HTTP`, null, text['Evolution'])%></li>
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we remove all the smartLink parameters except the first one? It'll automatically draw short-title || title from the page.

Copy link
Member Author

Choose a reason for hiding this comment

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

Do you mean all smartLinks should have the following format?

<ol>
  <li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Overview`)%></li>
  <li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Messages`)%></li>
  <li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Headers`)%></li>
  <li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Methods`)%></li>
  <li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Status`)%></li>
  <li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Session`)%></li>
  <li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Compression`)%></li>
  <li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Content_negotiation`)%></li>
  <li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Proxy_servers_and_tunneling`)%></li>
  <li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Connection_management_in_HTTP_1.x`)%></li>
  <li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Protocol_upgrade_mechanism`)%></li>
  <li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Evolution_of_HTTP`)%></li>
</ol>

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, exactly. This is how it will be in the new sidebar architecture.

@caugner caugner changed the title chore(http): Reorg HTTP sidebar after doc reshuffle, delete 'Basics of HTTP' chore(macros/HTTPSidebar): Reorg HTTP sidebar after doc reshuffle, delete 'Basics of HTTP' Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
macros tracking issues related to kumascript macros
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants