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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 12 commits into from
Oct 2, 2024
Merged

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

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
da34c5b
chore(http): Reorg HTTP sidebar after doc reshuffle, delete 'Basics o…
bsmth Sep 6, 2024
805a440
Merge branch 'main' into http-sidebar
bsmth Sep 7, 2024
d7e20e9
Merge branch 'mdn:main' into http-sidebar
bsmth Sep 10, 2024
ae44cd3
chore(http): improvements following reviewer feedback
bsmth Sep 10, 2024
b9ab548
test(macros/HTTPSidebar): update test expectation
caugner Sep 10, 2024
b56f871
Merge branch 'main' into http-sidebar
bsmth Sep 25, 2024
fb6c4a4
chore(macros/HTTPSidebar): remove 'null, text[...]' from smartLinks
bsmth Oct 1, 2024
bd9fc89
chore(macros/HTTPSidebar): remove 'null, text[...]' from smartLinks
bsmth Oct 1, 2024
07b1a62
Merge branch 'main' into http-sidebar
bsmth Oct 1, 2024
6bb6f68
chore(macros/HTTPSidebar): tests following sidebars changes
bsmth Oct 1, 2024
1d9ff29
chore(http): Changes following reviewer feedback, removed unused l10n…
bsmth Oct 2, 2024
dccee96
Merge branch 'main' into http-sidebar
bsmth Oct 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
222 changes: 108 additions & 114 deletions kumascript/macros/HTTPSidebar.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,14 @@ function state(section) {
var text = mdn.localStringMap({
'en-US': {
'HTTP': 'HTTP',
'HTTPGuide': 'HTTP guide',
'Basics': 'Basics of HTTP',
'Overview': 'Overview of HTTP',
'Evolution': 'Evolution of HTTP',
'ResourcesURI': 'Resources and URIs',
'URIsResources': 'URIs and resources',
'Identifying': 'Identifying resources on the Web',
bsmth marked this conversation as resolved.
Show resolved Hide resolved
'DataURLs': 'Data URLs',
'MIMETypes': 'Introduction to MIME types',
'ListMIMETypes': 'Common MIME types',
'WWWorNotWWW': 'Choosing between www and non-www URLs',
'WWWorNotWWW': 'Choosing www or non-www URLs',
'Messages': 'HTTP Messages',
'Session': 'A typical HTTP session',
'Connection1x': 'Connection management in HTTP/1.x',
Expand All @@ -37,8 +35,8 @@ var text = mdn.localStringMap({
'Compression': 'HTTP compression',
'Cookies': 'HTTP cookies',
'Caching': 'HTTP caching',
'CORS': 'HTTP access control (CORS)',
'Resources': 'HTTP specifications',
'CORS': 'Cross-Origin Resource Sharing (CORS)',
'Specifications': 'HTTP specifications',
'Permissions_Policy': 'Permissions Policy',
'Guides': 'Guides',
'Reference': 'References',
Expand All @@ -47,18 +45,20 @@ var text = mdn.localStringMap({
'CSPDirectives': 'CSP directives',
'CORS_errors': 'CORS errors',
'PermissionsPolicyDirectives': 'Permissions-Policy directives',
'Security': 'HTTP security',
'Security': 'Security and privacy',
'Authentication': 'HTTP authentication',
'ProtocolUpgradeMech': 'Protocol upgrade mechanism',
'CSP': 'Content Security Policy (CSP)'
'CSP': 'Content Security Policy (CSP)',
'Proxies': 'Proxy servers and tunneling',
'CORP': 'Cross-Origin Resource Policy (CORP)',
'SecurityGuides': 'Security implementation guides',
'ClientHints': "HTTP client hints"
},
'es': {
'HTTP': 'HTTP',
'HTTPGuide': 'Guía de HTTP',
'Basics': 'Fundamentos de HTTP',
'Overview': 'Generalidades de HTTP',
'Evolution': 'Evolución de HTTP',
'ResourcesURI': 'Recursos y URIs',
'URIsResources': 'Recursos y URIs',
'Identifying': 'Identificación de recursos en la Web',
'DataURLs': 'URLs de Datos',
'MIMETypes': 'Presentación de tipos MIME',
Expand All @@ -77,23 +77,25 @@ var text = mdn.localStringMap({
'Cookies': 'Cookies HTTP',
'Caching': 'Caché HTTP',
'CORS': 'Control de acceso en HTTP(CORS)',
'Resources': 'La especificación de HTTP',
'Specifications': 'La especificación de HTTP',
'Guides': 'Guías',
'Reference': 'Referencias',
'Methods': 'Métodos de petición HTTP',
'Status': 'Códigos de estado de HTTP',
'CSPDirectives': 'Directivas CSP',
'Security': 'Seguridad en HTTP',
'Authentication': 'Autenticación en HTTP',
'CSP': 'Content Security Policy (CSP)'
'CSP': 'Content Security Policy (CSP)',
'Proxies': 'Proxy servers and tunneling',
'CORP': 'Cross-Origin Resource Policy (CORP)',
'SecurityGuides': 'Security implementation guides',
'ClientHints': 'HTTP client hints'
},
'fr': {
'HTTP': 'HTTP',
'HTTPGuide': 'Guide HTTP',
'Basics': 'Notions élémentaires de HTTP',
'Overview': 'Aperçu de HTTP',
'Evolution': 'Évolution de HTTP',
'ResourcesURI': 'Ressources et URI',
'URIsResources': 'Ressources et URI',
'Identifying': 'Identifier des ressources sur le Web',
'DataURLs': 'URL de données',
'MIMETypes': 'Introduction aux types MIME',
Expand All @@ -112,7 +114,7 @@ var text = mdn.localStringMap({
'Cookies': 'Cookies HTTP',
'Caching': 'Cache HTTP',
'CORS': 'Contrôle d\'accès HTTP',
'Resources': 'Spécifications HTTP',
'Specifications': 'Spécifications HTTP',
'Permissions_Policy': 'Règles de fonctionnalité',
'Guides': 'Guides',
'Reference': 'Références',
Expand All @@ -124,15 +126,17 @@ var text = mdn.localStringMap({
'Security': 'Sécurité HTTP',
'Authentication': 'Authentification HTTP',
'ProtocolUpgradeMech': 'Mécanisme d\'amélioration du protocole',
'CSP': 'Content Security Policy (CSP)'
'CSP': 'Content Security Policy (CSP)',
'Proxies': 'Proxy servers and tunneling',
'CORP': 'Cross-Origin Resource Policy (CORP)',
'SecurityGuides': 'Security implementation guides',
'ClientHints': 'HTTP client hints'
},
'ja': {
'HTTP': 'HTTP',
'HTTPGuide': 'HTTP ガイド',
'Basics': 'HTTP の基本',
'Overview': 'HTTP の概要',
'Evolution': 'HTTP の進化',
'ResourcesURI': 'リソースと URI',
'URIsResources': 'リソースと URI',
'Identifying': 'ウェブ上のリソースの識別',
'DataURLs': 'データ URL',
'MIMETypes': 'MIME タイプ入門',
Expand All @@ -151,7 +155,7 @@ var text = mdn.localStringMap({
'Cookies': 'HTTP Cookie',
'Caching': 'HTTP キャッシュ',
'CORS': 'HTTP アクセス制御 (CORS)',
'Resources': 'HTTP 仕様書',
'Specifications': 'HTTP 仕様書',
'Permissions_Policy': '機能ポリシー',
'Guides': 'ガイド',
'Reference': 'リファレンス',
Expand All @@ -163,15 +167,17 @@ var text = mdn.localStringMap({
'Security': 'HTTP セキュリティ',
'Authentication': 'HTTP 認証',
'ProtocolUpgradeMech': 'プロトコルのアップグレードの仕組み',
'CSP': 'Content Security Policy (CSP)'
'CSP': 'Content Security Policy (CSP)',
'Proxies': 'Proxy servers and tunneling',
'CORP': 'Cross-Origin Resource Policy (CORP)',
'SecurityGuides': 'Security implementation guides',
'ClientHints': 'HTTP client hints'
},
'ko': {
'HTTP': 'HTTP',
'HTTPGuide': 'HTTP 안내서',
'Basics': 'HTTP 기본',
'Overview': 'HTTP 개요',
'Evolution': 'HTTP의 진화',
'ResourcesURI': '리소스와 URIs',
'URIsResources': '리소스와 URIs',
'Identifying': '웹의 리소스 식별하기',
'DataURLs': '데이터 URLs',
'MIMETypes': 'MIME 타입 소개',
Expand All @@ -190,7 +196,7 @@ var text = mdn.localStringMap({
'Cookies': 'HTTP 쿠키',
'Caching': 'HTTP 캐싱',
'CORS': 'HTTP 접근 제어(CORS)',
'Resources': 'HTTP 명세',
'Specifications': 'HTTP 명세',
'Permissions_Policy': 'Permissions policy',
'Guides': '가이드',
'Reference': '레퍼런스',
Expand All @@ -202,20 +208,22 @@ var text = mdn.localStringMap({
'Security': 'HTTP 보안',
'Authentication': 'HTTP 인증',
'ProtocolUpgradeMech': '프로토콜 업그레이드 메커니즘',
'CSP': 'Content Security Policy (CSP)'
'CSP': 'Content Security Policy (CSP)',
'Proxies': 'Proxy servers and tunneling',
'CORP': 'Cross-Origin Resource Policy (CORP)',
'SecurityGuides': 'Security implementation guides',
'ClientHints': 'HTTP client hints'
},
'ru': {
'HTTP': 'HTTP',
'HTTPGuide': 'Руководство по HTTP',
'Basics': 'Основы HTTP',
'Overview': 'Обзор протокола HTTP',
'Evolution': 'Эволюция протокола HTTP',
'ResourcesURI': 'Ресурсы и URI-адреса',
'URIsResources': 'Ресурсы и URI-адреса',
'Identifying': 'Идентификация ресурсов в Вебе',
'DataURLs': 'Data URL',
'MIMETypes': 'Введение в MIME типы',
'ListMIMETypes': 'Неполный список типов MIME',
'WWWorNotWWW': 'Choosing between www and non-www URLs',
'WWWorNotWWW': 'Choosing www or non-www URLs',
'Messages': 'Сообщения HTTP',
'Session': 'HTTP сессия',
'Connection1x': 'Управление подключениями в HTTP/1.x',
Expand All @@ -229,7 +237,7 @@ var text = mdn.localStringMap({
'Cookies': 'Куки HTTP',
'Caching': 'HTTP-кеширование',
'CORS': 'Контроль доступа в HTTP (CORS)',
'Resources': 'Спецификации HTTP',
'Specifications': 'Спецификации HTTP',
'Permissions_Policy': 'Permissions policy',
'Guides': 'Учебники',
'Reference': 'Справочники',
Expand All @@ -241,15 +249,17 @@ var text = mdn.localStringMap({
'Security': 'Безопасность в HTTP',
'Authentication': 'HTTP авторизация',
'ProtocolUpgradeMech': 'Protocol upgrade mechanism',
'CSP': 'Content Security Policy (CSP)'
'CSP': 'Content Security Policy (CSP)',
'Proxies': 'Proxy servers and tunneling',
'CORP': 'Cross-Origin Resource Policy (CORP)',
'SecurityGuides': 'Security implementation guides',
'ClientHints': 'HTTP client hints'
},
'zh-CN': {
'HTTP': 'HTTP',
'HTTPGuide': 'HTTP 指南',
'Basics': 'HTTP 基础',
'Overview': 'HTTP 概述',
'Evolution': 'HTTP 的发展',
'ResourcesURI': '资源和 URI',
'URIsResources': '资源和 URI',
'Identifying': '标识互联网上的内容',
'DataURLs': 'Data URL',
'MIMETypes': 'MIME 类型介绍',
Expand All @@ -268,7 +278,7 @@ var text = mdn.localStringMap({
'Cookies': 'HTTP cookie',
'Caching': 'HTTP 缓存',
'CORS': 'HTTP 访问控制（CORS）',
'Resources': 'HTTP 规范',
'Specifications': 'HTTP 规范',
'Permissions_Policy': '权限策略',
'Guides': '指南：',
'Reference': '参考：',
Expand All @@ -280,104 +290,88 @@ var text = mdn.localStringMap({
'Security': 'HTTP 安全',
'Authentication': 'HTTP 认证',
'ProtocolUpgradeMech': '协议升级机制',
'CSP': '内容安全策略（CSP）'
'CSP': '内容安全策略（CSP）',
'Proxies': 'Proxy servers and tunneling',
'CORP': 'Cross-Origin Resource Policy (CORP)',
'SecurityGuides': 'Security implementation guides',
'ClientHints': 'HTTP client hints'
}
});
%>


<section id="Quick_links" data-macro="HTTPSidebar">
<ol>
<li class="section"><%-web.smartLink(`/${locale}/docs/Web/HTTP`, null, text['HTTP'])%></li>
<li class="section"><%-web.smartLink(`/${locale}/docs/Web/HTTP`)%></li>
<li class="section no-link"><%=text['Guides']%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Overview`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Session`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Messages`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/MIME_types`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Compression`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Caching`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Authentication`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Cookies`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Redirections`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Conditional_requests`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Range_requests`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Content_negotiation`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Connection_management_in_HTTP_1.x`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Evolution_of_HTTP`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Protocol_upgrade_mechanism`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Proxy_servers_and_tunneling`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Client_hints`)%></li>
<li class="toggle">
<details>
<summary><%=text['ResourcesURI']%></summary>
<ol>
<li><%-web.smartLink(`/${locale}/docs/Web/URI`, null, text['Identifying'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/URI/Schemes/data`, null, text['DataURLs'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Basics_of_HTTP/MIME_types`, null, text['MIMETypes'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types`, null, text['ListMIMETypes'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/URI/Authority/Choosing_between_www_and_non-www_URLs`, null, text['WWWorNotWWW'])%></li>
</ol>
</details>
<details>
<summary><%=text['Security']%></summary>
<ol>
<li><%-web.smartLink(`/${locale}/docs/Web/Security/Practical_implementation_guides`)%></li>
<li><a href="/en-US/observatory">HTTP Observatory</a></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Permissions_Policy`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/CSP`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/CORS`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Cross-Origin_Resource_Policy`)%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Headers/Strict-Transport-Security`, null, "HTTP Strict Transport Security (HSTS)")%></li>
bsmth marked this conversation as resolved.
Show resolved Hide resolved
</ol>
</details>
</li>
<li class="toggle">
<details>
<summary><%=text['HTTPGuide']%></summary>
<ol>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Basics_of_HTTP`, null, text['Basics'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Overview`, null, text['Overview'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Basics_of_HTTP/Evolution_of_HTTP`, null, text['Evolution'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Messages`, null, text['Messages'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Session`, null, text['Session'])%></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>
</ol>
</details>
</li>
<li class="toggle">
<details>
<summary><%=text['Security']%></summary>
<ol>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/CSP`, null, text['CSP'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Headers/Strict-Transport-Security`, null, "HTTP Strict Transport Security (HSTS)")%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Headers/X-Content-Type-Options`, null, "X-Content-Type-Options")%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Headers/X-Frame-Options`, null, "X-Frame-Options")%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Headers/X-XSS-Protection`, null, "X-XSS-Protection")%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/Security/Practical_implementation_guides`)%></li>
<li><a href="/en-US/observatory">HTTP Observatory</a></li>
</ol>
</details>
</li>

<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/CORS`, null, text['CORS'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Authentication`, null, text['Authentication'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Caching`, null, text['Caching'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Compression`, null, text['Compression'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Conditional_requests`, null, text['Conditionals'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Content_negotiation`, null, text['ContentNego'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Cookies`, null, text['Cookies'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Range_requests`, null, text['Ranges'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Redirections`, null, text['Redirects'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Resources_and_specifications`, null, text['Resources'])%></li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Permissions_Policy`, null, text['Permissions_Policy'])%></li>
<li class="section no-link"><%=text['Reference']%></li>
<li class="toggle">
<details <%=state('Web/HTTP/Headers')%>>
<summary><%=text['Headers']%></summary>
<%-await template("ListSubpagesForSidebar", ['/en-US/docs/Web/HTTP/Headers'])%>
</details>
<details <%=state('Web/HTTP/Headers')%>>
<summary><%=text['Headers']%></summary>
<%-await template("ListSubpagesForSidebar", ['/en-US/docs/Web/HTTP/Headers'])%>
</details>
</li>
<li class="toggle">
<details <%=state('Web/HTTP/Methods')%>>
<summary><%=text['Methods']%></summary>
<%-await template("ListSubpagesForSidebar", ['/en-US/docs/Web/HTTP/Methods'])%>
</details>
<details <%=state('Web/HTTP/Methods')%>>
<summary><%=text['Methods']%></summary>
<%-await template("ListSubpagesForSidebar", ['/en-US/docs/Web/HTTP/Methods'])%>
</details>
</li>
<li class="toggle">
<details <%=state('Web/HTTP/Status')%>>
<summary><%=text['Status']%></summary>
<%-await template("ListSubpagesForSidebar", ['/en-US/docs/Web/HTTP/Status'])%>
</details>
<details <%=state('Web/HTTP/Status')%>>
<summary><%=text['Status']%></summary>
<%-await template("ListSubpagesForSidebar", ['/en-US/docs/Web/HTTP/Status'])%>
</details>
</li>
<li class="toggle">
<details <%=state('Web/HTTP/Headers/Content-Security-Policy')%>>
<summary><%=text['CSPDirectives']%></summary>
<%-await template("ListSubpagesForSidebar", ['/en-US/docs/Web/HTTP/Headers/Content-Security-Policy'])%>
</details>
<details <%=state('Web/HTTP/Headers/Content-Security-Policy')%>>
<summary><%=text['CSPDirectives']%></summary>
<%-await template("ListSubpagesForSidebar", ['/en-US/docs/Web/HTTP/Headers/Content-Security-Policy'])%>
</details>
</li>
<li class="toggle">
<details <%=state('Web/HTTP/CORS/Errors')%>>
<summary><%=text['CORS_errors']%></summary>
<%-await template("ListSubpagesForSidebar", ['/en-US/docs/Web/HTTP/CORS/Errors', 1])%>
</details>
<details <%=state('Web/HTTP/CORS/Errors')%>>
<summary><%=text['CORS_errors']%></summary>
<%-await template("ListSubpagesForSidebar", ['/en-US/docs/Web/HTTP/CORS/Errors', 1])%>
</details>
</li>
<li class="toggle">
<details <%=state('Web/HTTP/Headers/Permissions-Policy')%>>
<summary><%=text['PermissionsPolicyDirectives']%></summary>
<%-await template("ListSubpagesForSidebar", ['/en-US/docs/Web/HTTP/Headers/Permissions-Policy', 1])%>
</details>
<details <%=state('Web/HTTP/Headers/Permissions-Policy')%>>
<summary><%=text['PermissionsPolicyDirectives']%></summary>
<%-await template("ListSubpagesForSidebar", ['/en-US/docs/Web/HTTP/Headers/Permissions-Policy', 1])%>
</details>
</li>
<li><%-web.smartLink(`/${locale}/docs/Web/HTTP/Resources_and_specifications`)%></li>
</ol>
</section>
Loading
Loading