--- /dev/null
+# Update content of a page
+
+## Video of this tutorial
+
+<video src="videos/edit-a-page.mp4" controls></video>
+
+
+# Tutorial
+
+## Go to the page
+
+- Go to the `content` folder
+
+
+
+- Open the page you want to update
+- Click on Edit -> Edit single file
+
+
+
+
+## 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)
+
+
+
+
+### 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 `<section>` tags.
+
+## blocks of a page are always inside `{{<section>}}` block
+ ```markdown
+ {{<section>}}
+ content
+ {{</section>}}
+ ```
+
+If you only want to write text inside a section you can use the attribute `md="true"` on a `section` tag.
+
+```markdown
+{{<section md="true">}}
+ content
+{{</section>}}
+```
+
+Or you can mix components and <md> tags.
+
+```markdown
+{{<section>}}
+ {{<md>}}
+ markdown **content**
+ {{</md>}}
+ {{<component name="carousel" >}} ... {{</component>}}
+
+ {{<md>}}
+ markdown content
+ {{</md>}}
+{{</section>}}
+```
+
+Example :
+
+
+## Components:
+
+All Component can be seen in the page [Components](components.md)
+
+## Save the page
+
+- Clic on the button `Commit changes`
+
+
+
+- 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`
+
+
+
+++ /dev/null
-# Advanced Editing
-
-
-## Buttons
-
-
-
-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
- <a href="/path" class="btn btn-primary">Primary button</a>
- ```
-
-- **Secondary Button**: Alternative or secondary actions
- ```markdown
- <a href="/path" class="btn btn-secondary">Secondary button</a>
- ```
-
-- **Tertiary Button**: Less prominent actions
- ```markdown
- <a href="/path" class="btn btn-tertiary">Tertiary button</a>
- ```
-
-### Icons in Buttons
-
-
-
-Buttons can include icons from the Font Awesome library. The convention is:
-
-- Internal links use the arrow-right icon:
- ```markdown
- <a href="/internal-page" class="btn btn-primary">
- Internal link <i class="fas fa-arrow-right"></i>
- </a>
- ```
-
-- External links use the external link icon:
- ```markdown
- <a href="https://external-site.com" class="btn btn-primary" target="_blank">
- External link <i class="fas fa-arrow-up-right-from-square"></i>
- </a>
- ```
-
-- Download links use the download icon:
- ```markdown
- <a href="/download" class="btn btn-secondary">
- Download <i class="fas fa-download"></i>
- </a>
- ```
-
-## 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
- <a href="/internal-page">Internal link</a>
- ```
-
-- **External links**: Include target="_blank" to open in new tab
- ```markdown
- <a href="https://external-site.com" target="_blank">
- External link <i class="fas fa-arrow-up-right-from-square"></i>
- </a>
- ```
-
-- **Download links**: Include the download icon
- ```markdown
- <a href="/path/to/file.pdf">
- Download PDF <i class="fas fa-download"></i>
- </a>
- ```
-
-
-
-## 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
- [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)
--- /dev/null
+# Advanced Editing
+
+
+## Buttons
+
+
+
+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
+ <a href="/path" class="btn btn-primary">Primary button</a>
+ ```
+
+- **Secondary Button**: Alternative or secondary actions
+ ```markdown
+ <a href="/path" class="btn btn-secondary">Secondary button</a>
+ ```
+
+- **Tertiary Button**: Less prominent actions
+ ```markdown
+ <a href="/path" class="btn btn-tertiary">Tertiary button</a>
+ ```
+
+### Icons in Buttons
+
+
+
+Buttons can include icons from the Font Awesome library. The convention is:
+
+- Internal links use the arrow-right icon:
+ ```markdown
+ <a href="/internal-page" class="btn btn-primary">
+ Internal link <i class="fas fa-arrow-right"></i>
+ </a>
+ ```
+
+- External links use the external link icon:
+ ```markdown
+ <a href="https://external-site.com" class="btn btn-primary" target="_blank">
+ External link <i class="fas fa-arrow-up-right-from-square"></i>
+ </a>
+ ```
+
+- Download links use the download icon:
+ ```markdown
+ <a href="/download" class="btn btn-secondary">
+ Download <i class="fas fa-download"></i>
+ </a>
+ ```
+
+## 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
+ <a href="/internal-page">Internal link</a>
+ ```
+
+- **External links**: Include target="_blank" to open in new tab
+ ```markdown
+ <a href="https://external-site.com" target="_blank">
+ External link <i class="fas fa-arrow-up-right-from-square"></i>
+ </a>
+ ```
+
+- **Download links**: Include the download icon
+ ```markdown
+ <a href="/path/to/file.pdf">
+ Download PDF <i class="fas fa-download"></i>
+ </a>
+ ```
+
+
+
+## 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
"header-logo",
"header-nav",
"hero-block",
+ "highlight",
"home-hero-animated",
"home-section-hero",
"image-ratio-large",
"main",
"media-block",
"media-block--left",
- "media-block--mobile-bottom",
"media-block--right",
"media-block__content",
"media-block__label",
"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",
"xen-project-advisory-board",
"xen-project-hypervisor",
"xen-project-matrix",
+ "xen-project-tree-code-signing-and-announcements",
"xen-project-wide-roles"
]
}
projects / www-xenproject-org.git / commitdiff
