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

Format section templates and PR template accordingly #2396

Merged
merged 25 commits into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
cd770d7
Fix menu layout
pipo02mix Oct 31, 2024
ee13014
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 4, 2024
7e58227
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 8, 2024
07259f5
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 11, 2024
8c02bc1
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 22, 2024
32826e9
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 25, 2024
f13d72e
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 26, 2024
4be15bf
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 26, 2024
6a8a7fb
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 28, 2024
5226baa
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 28, 2024
90a3280
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 28, 2024
ec8bf59
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 29, 2024
5bcf3e3
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 29, 2024
f45f5be
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 29, 2024
2d35a47
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 29, 2024
51b76c5
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 29, 2024
240d425
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 29, 2024
e04c77a
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Dec 2, 2024
ce17f5c
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Dec 3, 2024
7032544
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Dec 3, 2024
b3a3f28
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Dec 5, 2024
779e1fb
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Dec 9, 2024
54290f1
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Dec 12, 2024
b59f8e3
Standarize templates and format PR template too
pipo02mix Dec 12, 2024
04fd6d4
Merge branch 'main' into pr-templates
pipo02mix Dec 12, 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
8 changes: 3 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
### What this PR does / why we need it

<!-- Please mention any GitHub issue, set a descriptive PR title, and use this space for additional explanations. -->
<!-- Reference a GitHub issue, set a descriptive PR title, and use this space for additional explanations. -->

### Things to check/remember before submitting

- If you made content changes

- Run `make lint dev` to render and proofread content changes locally.
- Bump `last_review_date` in the front matter header if you reviewed the entire page.
- If it's one of your first contributions, make sure you've read the [Contributing Guidelines](https://handbook.giantswarm.io/docs/content/docs-guide).
- Bump `last_review_date` in the front matter header of the pages you've touched.
2 changes: 1 addition & 1 deletion src/content/getting-started/_template.md.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ user_questions:
- List of questions that users might ask about this topic.
---

Today, the `getting started` pages are about guiding a new user or platform engineer to build their platform with Giant Swarm. The articles are ordered to be followed one after the other to show all the features we offer from the suffice. If you want to go deeper into the topics, we have tutorials or reference pages for that purpose. Here is just an introduction.
Today, the `getting started` pages are about guiding a new user or platform engineer to build their platform with Giant Swarm. The articles are ordered to be followed one after the other to show all the features we offer from the suffice. Also, read the [contributing guideline](https://handbook.giantswarm.io/docs/content/docs-guide) before writing the content.

Recommended sections can help you to start with the article:

Expand Down
2 changes: 1 addition & 1 deletion src/content/overview/_template.md.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ user_questions:
- List of questions that users might ask about this topic.
---

Could you describe the area topic from an overview point of view? Don`t go too deep into the matter; we have tutorials or reference pages for that purpose. Here is just an introduction.
Could you describe the area topic from an overview point of view? Don`t go too deep into the matter; use tutorials or reference pages for technical content. Here we explain our product for a high level person. Also, read the [contributing guideline](https://handbook.giantswarm.io/docs/content/docs-guide) before writing the content.

Here, you can write an intro paragraph that responds to the question, "What do we mean by `TOPIC_TO_DEVELOP`"

Expand Down
30 changes: 30 additions & 0 deletions src/content/tutorials/_template.md.tpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Short title for this page, it is shown as title in upper section and menu
description: At least 70 characters that describe the purpose of this page.
weight: from 10 to 100. Lower is higher in the menu.
last_review_date: 2025-01-01
owner:
- https://github.com/orgs/giantswarm/teams/${OWNER}
user_questions:
- List of questions that users might ask about this topic.
---

Today, the `tutorials` represent the content for advanced users which needs some guidance to accomplish or learn about certain topics. We recommend to create an outline of the tutorial before writing the content.

Some sections that can be included in a tutorial are:

## Introduction (dont need this title)

General description of the goal you want to achieve. It should be a brief explanation of what the user will learn in this tutorial.

## Requirements

Indicate the prerequisites that the user must have to follow the tutorial. For example, a specific version of the software, a specific configuration, or a specific environment.

## Steps or Process (H2 section title)

Describe the steps or process that the user must follow to achieve or learn about the matter. Follow the [contributing guidelines](https://handbook.giantswarm.io/docs/content/docs-guide) to write the content.

## Next steps or Follow-up

Internal or external links to other tutorials or resources that the user can follow to continue learning about the topic.
Loading