From: Arnaud Guéras Date: Mon, 6 Jan 2025 22:13:45 +0000 (+0100) Subject: doc update X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=3cd58ca11888f645f5cdd7d26079fef804fae9b4;p=www-xenproject-org.git doc update Signed-off-by: Arnaud Guéras --- diff --git a/docs/edit-a-page.md b/docs/edit-a-page.md new file mode 100644 index 0000000..3ed04e1 --- /dev/null +++ b/docs/edit-a-page.md @@ -0,0 +1,144 @@ +# Update content of a page + +## Video of this tutorial + + + + +# Tutorial + +## Go to the page + +- Go to the `content` folder + +![Content folder structure](images/gitlab/content-folder.png) + +- Open the page you want to update +- Click on Edit -> Edit single file + +![Edit single file](images/gitlab/page-edit-single-file.png) + + +## Update the Header of the page + +The front matter is the metadata at the top of each page file. It includes information like the page title, description, and other settings. + +You can have more information of the front matter here : [Front matter](page-editing.md#front-matter) + +> **Warning**: Any change of the front matter of a page could change the header (ie: change the title of the page) + +![Header of the page](images/gitlab/page-edit-header.png) + + +### Default Parameters + +Based on analysis of typical pages, the front matter usually includes: + +| Parameter | Description | +| ----------- | ------------------------------------------------------------------------------------------------------------- | +| title | The page title | +| description | A brief description of the page | +| keywords | Keywords for the page, used for SEO | +| layout | The layout type used for the page, all the pages use the layout "single" | +| date | Publication date (often used for blog posts) | +| draft | If the page is a draft, set to true, if the page is ready and published, set to false or delete the parameter | + +These parameters help structure and organize the site content while providing useful metadata for SEO and navigation. + +The parameters `title`, `description` are use for the main title and description of the page. You can see them at the top of the page. + +The parameters `title`, `description` and `keywords` are used for SEO and are used to help search engines understand the content of the page. + +The parameter `draft` is used to indicate if the page is a draft or not. If the page is a draft, it will not be published. + + +### Show a page in the menu + +By default, all the pages are shown in the menu. If you don't want to show a page in the menu, you can set the `hidden` parameter to `true`. + +The pages are grouped into folders, but their position in the menu is determined by the `menu.main` and `weight` parameters. + +To order the pages in the menu, you can set the `weight` parameter to the desired value. The lower the number, the higher up in the menu the page will be. + +Example : + + +**Page downloads.md** + +```yaml +title: Downloads +menus: + main: + parent: Resources + weight: 50 +``` + +**Page Matrix.md** + +```yaml +title: Matrix +menus: + main: + parent: Resources + weight: 70 +``` + +The page **Matrix** is after the page **Downloads** in the menu because it has a higher `weight` value. + +# Update the content + +All the content below the front matter is the content of the page. + +You can use markdown to format your content. + +In the context of the project, all block of a page are inside `
` tags. + +## blocks of a page are always inside `{{
}}` block + ```markdown + {{
}} + content + {{
}} + ``` + +If you only want to write text inside a section you can use the attribute `md="true"` on a `section` tag. + +```markdown +{{
}} + content +{{
}} +``` + +Or you can mix components and tags. + +```markdown +{{
}} + {{}} + markdown **content** + {{}} + {{}} ... {{}} + + {{}} + markdown content + {{}} +{{
}} +``` + +Example : +![code component both sides](images/gitlab/code-component-both-sides.png) + +## Components: + +All Component can be seen in the page [Components](components.md) + +## Save the page + +- Clic on the button `Commit changes` + +![Commit button](images/gitlab/commit-change-button.png) + +- Write a message for the commit +- Verify the branch is `main` if you want to make a change in production. +- Clic on the button `Commit changes` + +![Commit changes](images/gitlab/commit-change-dialog.png) + diff --git a/docs/images/gitlab/code-component-both-sides.png b/docs/images/gitlab/code-component-both-sides.png new file mode 100644 index 0000000..0c9fee9 Binary files /dev/null and b/docs/images/gitlab/code-component-both-sides.png differ diff --git a/docs/images/gitlab/commit-change-button.png b/docs/images/gitlab/commit-change-button.png new file mode 100644 index 0000000..07697c0 Binary files /dev/null and b/docs/images/gitlab/commit-change-button.png differ diff --git a/docs/images/gitlab/commit-change-dialog.png b/docs/images/gitlab/commit-change-dialog.png new file mode 100644 index 0000000..1dcfa29 Binary files /dev/null and b/docs/images/gitlab/commit-change-dialog.png differ diff --git a/docs/images/gitlab/content-folder.png b/docs/images/gitlab/content-folder.png new file mode 100644 index 0000000..52fb613 Binary files /dev/null and b/docs/images/gitlab/content-folder.png differ diff --git a/docs/images/gitlab/page-edit-header.png b/docs/images/gitlab/page-edit-header.png new file mode 100644 index 0000000..972814b Binary files /dev/null and b/docs/images/gitlab/page-edit-header.png differ diff --git a/docs/images/gitlab/page-edit-single-file.png b/docs/images/gitlab/page-edit-single-file.png new file mode 100644 index 0000000..9e8bf09 Binary files /dev/null and b/docs/images/gitlab/page-edit-single-file.png differ diff --git a/docs/page-advanced-editing.md b/docs/page-advanced-editing.md deleted file mode 100644 index c0c8695..0000000 --- a/docs/page-advanced-editing.md +++ /dev/null @@ -1,102 +0,0 @@ -# Advanced Editing - - -## Buttons - -![Buttons](images/buttons.png) - -Buttons are used to trigger actions or navigate to other pages. There are three types of buttons available: - -### Button Types - -- **Primary Button**: Main call-to-action buttons - ```markdown - Primary button - ``` - -- **Secondary Button**: Alternative or secondary actions - ```markdown - Secondary button - ``` - -- **Tertiary Button**: Less prominent actions - ```markdown - Tertiary button - ``` - -### Icons in Buttons - -![Buttons with icons](images/buttons-with-icons.png) - -Buttons can include icons from the Font Awesome library. The convention is: - -- Internal links use the arrow-right icon: - ```markdown - - Internal link - - ``` - -- External links use the external link icon: - ```markdown - - External link - - ``` - -- Download links use the download icon: - ```markdown - - Download - - ``` - -## Links - -Links follow similar conventions to buttons for consistency across the site: - -### Link Types - -- **Internal links**: Use regular markdown syntax or HTML - ```markdown - [Internal link](/internal-page) - ``` - or - ```markdown - Internal link - ``` - -- **External links**: Include target="_blank" to open in new tab - ```markdown - - External link - - ``` - -- **Download links**: Include the download icon - ```markdown - - Download PDF - - ``` - - - -## Using Components - -To use a component, simply copy the desired component code and paste it into your Markdown file. You can customize the content and parameters according to your needs. - -## Component Customization - -Each component can be customized with different parameters. Here are some examples: - -## Best Practices - -- Use components consistently throughout the site -- Avoid overloading a page with too many components - -## Advanced Tips - -- You can nest certain components within each other -- Components can be used on any page of the site -- Some components accept Markdown inside them \ No newline at end of file diff --git a/docs/readme.md b/docs/readme.md index a6f978b..83b028f 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -6,3 +6,8 @@ - [Page editing](page-editing.md) - [Page advanced editing](page-advanced-editing.md) - [Components](components.md) + + +## Main editing actions + +- [update headers and content](update-headers-and-content.md) diff --git a/docs/small-components.md b/docs/small-components.md new file mode 100644 index 0000000..c0c8695 --- /dev/null +++ b/docs/small-components.md @@ -0,0 +1,102 @@ +# Advanced Editing + + +## Buttons + +![Buttons](images/buttons.png) + +Buttons are used to trigger actions or navigate to other pages. There are three types of buttons available: + +### Button Types + +- **Primary Button**: Main call-to-action buttons + ```markdown + Primary button + ``` + +- **Secondary Button**: Alternative or secondary actions + ```markdown + Secondary button + ``` + +- **Tertiary Button**: Less prominent actions + ```markdown + Tertiary button + ``` + +### Icons in Buttons + +![Buttons with icons](images/buttons-with-icons.png) + +Buttons can include icons from the Font Awesome library. The convention is: + +- Internal links use the arrow-right icon: + ```markdown + + Internal link + + ``` + +- External links use the external link icon: + ```markdown + + External link + + ``` + +- Download links use the download icon: + ```markdown + + Download + + ``` + +## Links + +Links follow similar conventions to buttons for consistency across the site: + +### Link Types + +- **Internal links**: Use regular markdown syntax or HTML + ```markdown + [Internal link](/internal-page) + ``` + or + ```markdown + Internal link + ``` + +- **External links**: Include target="_blank" to open in new tab + ```markdown + + External link + + ``` + +- **Download links**: Include the download icon + ```markdown + + Download PDF + + ``` + + + +## Using Components + +To use a component, simply copy the desired component code and paste it into your Markdown file. You can customize the content and parameters according to your needs. + +## Component Customization + +Each component can be customized with different parameters. Here are some examples: + +## Best Practices + +- Use components consistently throughout the site +- Avoid overloading a page with too many components + +## Advanced Tips + +- You can nest certain components within each other +- Components can be used on any page of the site +- Some components accept Markdown inside them \ No newline at end of file diff --git a/docs/videos/edit-a-page.mp4 b/docs/videos/edit-a-page.mp4 new file mode 100644 index 0000000..790a4db Binary files /dev/null and b/docs/videos/edit-a-page.mp4 differ diff --git a/hugo_stats.json b/hugo_stats.json index a76275c..232835a 100644 --- a/hugo_stats.json +++ b/hugo_stats.json @@ -142,6 +142,7 @@ "header-logo", "header-nav", "hero-block", + "highlight", "home-hero-animated", "home-section-hero", "image-ratio-large", @@ -158,7 +159,6 @@ "main", "media-block", "media-block--left", - "media-block--mobile-bottom", "media-block--right", "media-block__content", "media-block__label", @@ -296,12 +296,14 @@ "scope-of-this-process", "security-response-team-members", "security-response-team-short-security-team", + "security-team-incoming-email", "specific-process", "sponsor", "sub-projects-and-teams", "submitting-patches-to-the-xen-project-codebase", "supports-multiple-cloud-platforms-cloudstack-openstack", "supports-multiple-guest-operating-systems-linux-windows-netbsd-freebsd", + "the-hypervisor-teams-openpgp-keys", "the-linux-foundation", "the-unikraft-build-tool", "trademark-policy", @@ -317,6 +319,7 @@ "xen-project-advisory-board", "xen-project-hypervisor", "xen-project-matrix", + "xen-project-tree-code-signing-and-announcements", "xen-project-wide-roles" ] }