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

Group XSLT docs into Guides and Reference #37825

Merged
merged 11 commits into from
Jan 31, 2025
Merged

Group XSLT docs into Guides and Reference #37825

merged 11 commits into from
Jan 31, 2025

Conversation

pepelsbey
Copy link
Member

@pepelsbey pepelsbey commented Jan 27, 2025

Moves pages into guides and reference folders

- web/xslt/element
+ web/xslt/reference/element
- web/xslt/common_errors
+ web/xslt/guides/common_errors
etc.

Creates landing pages for guides and references

+ web/xslt/reference/index.md
+ web/xslt/guides/index.md

Uses front-matter sidebar

+ sidebar: xsltsidebar
- {{XsltSidebar}}

Cleans up guides and landings

  • Removes duplicated info
  • Removes handmade breadcrumbs

Uses new page type

+ page-type: listing-page

Motivation

Docs IA & maintenance

TODO

  • Check links in BCD
  • Fix links in web-features

@pepelsbey pepelsbey requested a review from bsmth January 27, 2025 13:14
@pepelsbey pepelsbey requested review from a team as code owners January 27, 2025 13:14
@github-actions github-actions bot added Content:Other Any docs not covered by another "Content:" label Content:Meta Content in the meta docs system [PR only] Infrastructure and configuration for the project size/m [PR only] 51-500 LoC changed labels Jan 27, 2025
Copy link
Contributor

github-actions bot commented Jan 27, 2025

Preview URLs (90 pages)
Flaws (5)

Note! 87 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/XSLT/Reference/Element/stylesheet
Title: <xsl:stylesheet>
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Web/XSLT/Element/for-each-group

URL: /en-US/docs/Web/EXSLT/math/min
Title: math:min()
Flaw count: 2

  • broken_links:
    • /en-US/docs/Web/XSLT/Transforming_XML_with_XSLT is a redirect
    • /en-US/docs/Web/XSLT/Element is a redirect

URL: /en-US/docs/Web/EXSLT/math/max
Title: math:max()
Flaw count: 2

  • broken_links:
    • /en-US/docs/Web/XSLT/Transforming_XML_with_XSLT is a redirect
    • /en-US/docs/Web/XSLT/Element is a redirect
External URLs (3)

URL: /en-US/docs/Web/XSLT
Title: XSLT: Extensible Stylesheet Language Transformations


URL: /en-US/docs/Web/XPath/Axes
Title: Axes

(comment last updated: 2025-01-31 14:02:01)

bsmth
bsmth previously requested changes Jan 27, 2025
Copy link
Member

@bsmth bsmth left a comment

Choose a reason for hiding this comment

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

Could you please update the xsltsidebar like this?

-    path: /Web/XSLT/Transforming_XML_with_XSLT
+    path: /Web/XSLT/Guides/Transforming_XML_with_XSLT
   - type: section
-    link: /Web/XSLT/Element
+    link: /Web/XSLT/Reference/Element
   - type: listSubPages
-    path: /Web/XSLT/Element
+    path: /Web/XSLT/Reference/Element

title: XSLT guides
short-title: Guides
slug: Web/XSLT/Guides
page-type: listing-page
Copy link
Collaborator

Choose a reason for hiding this comment

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

How is this different to landing-page, which is described as:

a page that acts primarily as a navigation aid, listing links to other pages.

? Also, adding new page types is a pretty significant change, it would be nice if there could be a discussion involving all maintainers when new page types are proposed.

Copy link
Member Author

Choose a reason for hiding this comment

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

We’re still experimenting with a handful of sections to iron out the workflow and needed changes.

We’ll update the description of the generic page types to differentiate landings from listings.

@github-actions github-actions bot added size/l [PR only] 501-1000 LoC changed and removed size/m [PR only] 51-500 LoC changed labels Jan 30, 2025
github-actions[bot]

This comment was marked as outdated.

@github-actions github-actions bot removed the system [PR only] Infrastructure and configuration for the project label Jan 30, 2025
github-actions[bot]

This comment was marked as outdated.

@bsmth bsmth dismissed their stale review January 31, 2025 12:07

Changes applied


The element annotations that follow include a description, a syntax listing, a list of required and optional attributes, a description of type and position, its source in the W3C Recommendation and an explanation of the degree of present Gecko support.

- [`<xsl:apply-imports>`](/en-US/docs/Web/XSLT/Reference/Element/apply-imports)
Copy link
Member

Choose a reason for hiding this comment

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

I guess you can do {{ListSubpages}} but we'd miss the inline support info

@bsmth
Copy link
Member

bsmth commented Jan 31, 2025

I think to double-check sidebar: xsltsidebar v macro and if front-matter defined:

sidebar: xsltsidebar v

sidebar: 
  - xsltsidebar

Both are currently allowed.

Everything else gets a +1 from me 👍🏻

@pepelsbey pepelsbey changed the title Group XSLT docs into guides and references Group XSLT docs into Guides and Reference Jan 31, 2025
Copy link
Member

@bsmth bsmth left a comment

Choose a reason for hiding this comment

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

Approving with non-blocking comments 👍🏻

@Rumyra Rumyra merged commit 968a812 into mdn:main Jan 31, 2025
9 checks passed
@pepelsbey pepelsbey deleted the move/xslt branch January 31, 2025 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Meta Content in the meta docs Content:Other Any docs not covered by another "Content:" label size/l [PR only] 501-1000 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants