Skip to content

Commit db94836

Browse files
heiskrCopilot
andauthored
Remove product-guides layout and includeGuides infrastructure (#60621)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 2696e7a commit db94836

File tree

29 files changed

+4
-734
lines changed

29 files changed

+4
-734
lines changed

content/README.md

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ See the [contributing docs](https://docs.github.com/en/contributing) for general
2424
- [`defaultPlatform`](#defaultplatform)
2525
- [`defaultTool`](#defaulttool)
2626
- [`learningTracks`](#learningtracks)
27-
- [`includeGuides`](#includeguides)
2827
- [`journeyTracks`](#journeytracks)
2928
- [`journeyArticlesHeading`](#journeyarticlesheading)
3029
- [`contentType`](#contenttype)
@@ -41,7 +40,6 @@ See the [contributing docs](https://docs.github.com/en/contributing) for general
4140
- [Legacy filepaths and redirects for links](#legacy-filepaths-and-redirects-for-links)
4241
- [Index pages](#index-pages)
4342
- [Home page](#homepage)
44-
- [Creating new product guides pages](#creating-new-product-guides-pages)
4543

4644
## Frontmatter
4745

@@ -238,21 +236,6 @@ defaultTool: cli
238236

239237
**Note: the featured track is set by a specific property in the learning tracks YAML. See that [README](../data/learning-tracks/README.md) for details.*
240238

241-
### `includeGuides`
242-
- Purpose: Render a list of articles, filterable by `contentType`. Only applicable when used with `layout: product-guides`.
243-
- Type: `Array`
244-
- Optional.
245-
246-
Example:
247-
248-
```yaml
249-
includeGuides:
250-
- /actions/guides/about-continuous-integration
251-
- /actions/guides/setting-up-continuous-integration-using-workflow-templates
252-
- /actions/guides/building-and-testing-nodejs
253-
- /actions/guides/building-and-testing-powershell
254-
```
255-
256239
### `journeyTracks`
257240
- Purpose: Define journeys for journey landing pages.
258241
- Type: `Array` of objects with the following properties:
@@ -451,14 +434,3 @@ Index pages are the Table of Contents files for the docs site. Every product, ca
451434
The homepage is the main Table of Contents file for the docs site. The homepage must have a complete list of `children`, like every [Index page](#index-page) but must also specify the `childGroups` frontmatter property that will be highlighted in the main content area.
452435

453436
`childGroups` is an array of mappings containing a `name` for the group, an optional `icon` for the group, and an array of `children`. The `children` in the array must be present in the `children` frontmatter property.
454-
455-
### Creating new product guides pages
456-
457-
To create a product guides page (e.g. [Actions' Guide page](https://docs.github.com/en/actions/guides)), create or modify an existing markdown file with these specific frontmatter values:
458-
459-
1. Use the product guides page template by referencing `layout: product-guides`.
460-
1. (optional) Include the learning tracks in [`learningTracks`](#learningTracks).
461-
1. (optional) Define which articles to include with [`includeGuides`](#includeGuides).
462-
463-
If using learning tracks, they need to be defined in [`data/learning-tracks/*.yml`](../data/learning-tracks/README.md).
464-
If using `includeGuides`, make sure each of the articles in this list has [`contentType`](#contenttype) in its frontmatter.

content/contributing/writing-for-github-docs/using-yaml-frontmatter.md

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ For more information, see [`lib/frontmatter.ts`](https://github.com/github/docs/
4040
* [`defaultPlatform`](#defaultplatform)
4141
* [`defaultTool`](#defaulttool)
4242
* [`learningTracks`](#learningtracks)
43-
* [`includeGuides`](#includeguides)
4443
* [`journeyTracks`](#journeytracks)
4544
* [`type`](#type)
4645
* [`communityRedirect`](#communityredirect)
@@ -235,22 +234,6 @@ defaultTool: cli
235234
> [!NOTE]
236235
> The featured track is set by a specific property in the learning tracks YAML. See that [README](https://github.com/github/docs/blob/main/data/learning-tracks/README.md) for details.
237236

238-
### `includeGuides`
239-
240-
* Purpose: Render a list of articles, filterable by `type`. Only applicable when used with `layout: product-guides`.
241-
* Type: `Array`
242-
* Optional.
243-
244-
Example:
245-
246-
```yaml
247-
includeGuides:
248-
- /actions/guides/about-continuous-integration
249-
- /actions/guides/setting-up-continuous-integration-using-workflow-templates
250-
- /actions/guides/building-and-testing-nodejs
251-
- /actions/guides/building-and-testing-powershell
252-
```
253-
254237
### `journeyTracks`
255238

256239
* Purpose: Define journeys for journey landing pages.
@@ -337,14 +320,3 @@ Index pages are the table of contents files for the Docs site. Every product, ca
337320
The homepage is the main Table of Contents file for the docs site. The homepage must have a complete list of `children`, like every [Index page](#index-pages) but must also specify the `childGroups` frontmatter property that will be highlighted in the main content area.
338321

339322
`childGroups` is an array of mappings containing a `name` for the group, an optional `icon` for the group, and an array of `children`. The `children` in the array must be present in the `children` frontmatter property.
340-
341-
## Creating new product guides pages
342-
343-
To create a product guides page (e.g. [{% data variables.product.prodname_actions %} Guide page](/actions/guides)), create or modify an existing markdown file with these specific frontmatter values:
344-
345-
* Use the product guides page template by referencing `layout: product-guides`.
346-
* Include the learning tracks in [`learningTracks`](#learningtracks). Optional.
347-
* Define which articles to include with [`includeGuides`](#includeguides). Optional.
348-
349-
If using learning tracks, they need to be defined in [`data/learning-tracks/*.yml`](https://github.com/github/docs/tree/main/data/learning-tracks).
350-
If using `includeGuides`, make sure each of the articles in this list has [`type`](#type) in its frontmatter.

content/issues/guides.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

content/issues/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ children:
3535
- /planning-and-tracking-with-projects
3636
- /organizing-your-work-with-project-boards
3737
- /using-labels-and-milestones-to-track-work
38-
- /guides
3938
redirect_from:
4039
- /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests
4140
- /github/managing-your-work-on-github/managing-your-work-with-issues
@@ -61,5 +60,6 @@ redirect_from:
6160
- /disabling-issues
6261
- /linking-a-pull-request-to-an-issue
6362
- /about-duplicate-issues-and-pull-requests
63+
- /issues/guides
6464
- /video-transcripts/transcript-using-projects-for-feature-planning
6565
---

content/sponsors/guides.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

content/sponsors/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ introLinks:
88
redirect_from:
99
- /categories/supporting-the-open-source-community-with-github-sponsors
1010
- /github/supporting-the-open-source-community-with-github-sponsors
11+
- /sponsors/guides
1112
changelog:
1213
label: sponsors
1314
layout: discovery-landing
@@ -36,5 +37,4 @@ children:
3637
- /sponsoring-open-source-contributors
3738
- /receiving-sponsorships-through-github-sponsors
3839
- /integrating-with-github-sponsors
39-
- /guides
4040
---

data/ui.yml

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -306,24 +306,6 @@ product_landing:
306306
view: View all
307307
all_docs: 'All {{ title }} docs'
308308
all_content: 'View all {{ title }} content'
309-
product_guides:
310-
learning_paths_title: '{{ name }} learning paths'
311-
start_path: Start learning path
312-
learning_paths_desc: Learning paths are a collection of guides that help you master a particular subject.
313-
more_guides: more guides
314-
load_more: Load more guides
315-
all_guides_title: 'All {{ name }} guides'
316-
filter_instructions: Filter the guide list using these controls
317-
guides_found:
318-
multiple: '{n} guides found'
319-
one: 1 guide found
320-
none: No guides found
321-
guide_types:
322-
get-started: Quickstart
323-
concepts: Concepts
324-
how-tos: How-to guide
325-
tutorials: Tutorial
326-
reference: Reference
327309
learning_track_nav:
328310
prev_guide: Previous
329311
next_guide: Next

src/article-api/tests/product-guides-transformer.ts

Lines changed: 0 additions & 37 deletions
This file was deleted.

src/article-api/transformers/index.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ import { BespokeLandingTransformer } from './bespoke-landing-transformer'
1414
import { JourneyLandingTransformer } from './journey-landing-transformer'
1515
import { CategoryLandingTransformer } from './category-landing-transformer'
1616
import { DiscoveryLandingTransformer } from './discovery-landing-transformer'
17-
import { ProductGuidesTransformer } from './product-guides-transformer'
1817
import { ProductLandingTransformer } from './product-landing-transformer'
1918
import { SearchPageTransformer } from './search-page-transformer'
2019
import { ArticleTransformer } from './article-transformer'
@@ -40,7 +39,6 @@ transformerRegistry.register(new BespokeLandingTransformer())
4039
transformerRegistry.register(new JourneyLandingTransformer())
4140
transformerRegistry.register(new CategoryLandingTransformer())
4241
transformerRegistry.register(new DiscoveryLandingTransformer())
43-
transformerRegistry.register(new ProductGuidesTransformer())
4442
transformerRegistry.register(new ProductLandingTransformer())
4543
transformerRegistry.register(new SearchPageTransformer())
4644
// ArticleTransformer is the catch-all — must be registered last.

0 commit comments

Comments
 (0)