]> xenbits.xensource.com Git - www-xenproject-org.git/commitdiff
add docs and tutorial
authorArnaud Guéras <arnaudgs@gmail.com>
Tue, 10 Dec 2024 20:55:58 +0000 (21:55 +0100)
committerArnaud Guéras <arnaudgs@gmail.com>
Wed, 11 Dec 2024 08:04:24 +0000 (09:04 +0100)
Signed-off-by: Arnaud Guéras <arnaudgs@gmail.com>
content/template.md [new file with mode: 0644]
docs/components/media-block.md
docs/readme.md
docs/tutorial.md [new file with mode: 0644]
hugo_stats.json

diff --git a/content/template.md b/content/template.md
new file mode 100644 (file)
index 0000000..315e182
--- /dev/null
@@ -0,0 +1,269 @@
+---
+title: Title
+description: Description
+keywords: Keyworkds
+date: 2024-01-01T00:00:00+01:00
+draft: false
+menus:
+  main:
+    parent: Resources
+    weight: 100
+---
+
+<!-- Section block : Content must always be between section -->
+{{<section>}}
+
+{{<section>}}
+
+
+<!-- Mediablock : block with image and text, refer to the doc "docs/components/media-block.md" -->
+{{<section>}}
+  {{<media-block
+    title="mediablock"
+    media="/img/flatline/new-message.svg"
+    alt="Illustration of a person sending a message, symbolizing communication."
+    animate="true"
+  >}}
+  {{<md>}}
+Xen Project mailing lists have a web as well as an email interface.
+
+- Send an email command to **[mylist-request@lists.xenproject.org](mailto:mylist-request@lists.xenproject.org)** (mylist may, for example, be xen-announce) with one of the [following commands](https://www.list.org/mailman-member/node41.html) in the subject line. Common commands are `help`, `subscribe`, and `unsubscribe`. Alternatively, you can use the SUBSCRIBE buttons below.
+
+- Go to **[https://lists.xenproject.org/mailman/listinfo/mylist](https://lists.xenproject.org/mailman/listinfo/mylist)** (mylist may, for example, be xen-announce) and use the web interface to subscribe, unsubscribe, or log into the list management interface.
+
+- You can send a note to a Xen Project mailing list without being subscribed to it, but your post will be moderated.
+
+- If you have problems, please email **[community.manager@xenproject.org](mailto:community.manager@xenproject.org)**.
+  {{</md>}}
+  {{</media-block>}}
+{{</section>}}
+
+
+{{<section class="txt-c">}}
+  <h2>{{<md>}}Consider **searching in archives**, the answer you are looking might already exist!{{</md>}}</h2>
+
+  <p class="mg-t-md ">
+    <a href="https://lore.kernel.org/xen-devel/" class="btn btn-secondary">
+      Check out archives <i class="fas fa-arrow-up-right-from-square"></i>
+    </a>
+    </p>
+{{</section>}}
+
+
+
+{{<section class="section-square-rounded">}}
+{{<md>}}
+## General
+{{</md>}}
+
+{{<row-from-list class="align-flex-start" component="card" component-class="card--bg" titleLevel="2" cols="3">}} 
+- title: XEN-ANNOUNCE@
+  tags:
+    - Mailing list
+  description: Announcements related to the project. These may be release announcements, security advisories, announcements related to events. This is a low volume list, with about 1-2 posts per month.
+  link: "https://lists.xenproject.org/cgi-bin/mailman/listinfo/xen-announce"
+  linkText: Info
+  secondaryLink: "https://lists.xenproject.org/archives/html/xen-announce"
+  secondaryLinkText: Archives
+
+- title: XEN-USERS@
+  tags:
+    - Mailing list 
+  description: This list is for those using and installing the Xen Project software.
+  link: "https://lists.xenproject.org/cgi-bin/mailman/listinfo/xen-users"
+  linkText: Info
+  secondaryLink: "https://lists.xenproject.org/archives/html/xen-users"
+  secondaryLinkText: Archives
+
+- title: OSSTEST-OUTPUT@
+  tags:
+    - Mailing list
+  description: This is a receive-only list to which detailed test results and reports from the Xen Project Test Lab are sent. This is a very high volume list with 500+ e-mails a day. Only subscribe to it with filters set up. Principal test results are posted to the xen-devel list.
+  link: "https://lists.xenproject.org/cgi-bin/mailman/listinfo/osstest-output"
+  linkText: Info
+  secondaryLink: "https://lists.xenproject.org/archives/html/osstest-output"
+  secondaryLinkText: Archives
+
+- title: SECURITY@XENPROJECT.ORG
+  tags: 
+    - Mailing list
+  description: This e-mail alias is intended for reporting security vulnerabilities in Xen Project software (this also covers the situation where an existing published codebase is retrospectively found to be a security fix). List membership is restricted to members of the Xen Project Security Response Team and thus invite only and obviously, there is no public archive. For more information on how the Xen Project handles security vulnerabilities, see the Xen Security Problem Response Process.
+  link: "mailto:security@xenproject.org"
+  linkText: Report Security Issue
+
+- title: PRIVATE@
+  tags:
+    - Mailing list
+  description: This list is for maintainers of all Xen teams, and key developers that have been invited by maintainers. This list is intended to be used only when privacy implications or similar prevent usage of a public list. Example usage may be to let other community members know of absences (due to holidays, maternity/ paternity leave, etc.) and to arrange cover. Another example may be to ask other team members for advice on how to respond to a difficult situation in the community. Any conversations that should have been started on a public list, will be forwarded to an appropriate public list. This list is an invite-only list and is not archived. Community members can subscribe, but approval in line with Mailing List Conventions is required.
+  link: "https://lists.xenproject.org/cgi-bin/mailman/listinfo/private"
+  linkText: Info
+
+- title: PUBLICITY@
+  tags:
+    - Mailing list
+  description: This is a list to coordinate content for the Xen Project blog, articles in the open source and Linux press, other media, press activities, to coordinate attendance and submissions for open source and industry events and anything else to promote the Xen Project. The list is open for people in the community who care about promoting the Xen Project. The list is also archived. To join, please email the Community Manager.
+  link: "https://lists.xenproject.org/cgi-bin/mailman/listinfo/publicity"
+  linkText: Info 
+  secondaryLink: "https://lists.xenproject.org/archives/html/publicity"
+  secondaryLinkText: Archives
+
+{{</row-from-list>}}
+
+
+
+
+{{<md class="mg-t-xl">}}
+## Developers
+
+### Xen Project Hypervisor
+{{</md>}}
+
+{{<row-from-list component="card" component-class="card--bg" titleLevel="2" cols="3" class="mg-t-md align-flex-start">}} 
+- title: XEN-DEVEL@
+  tags:
+    - Mailing list
+  description: A discussion list for the Xen Project Hypervisor developer community. Please do not use this list for technical support queries.
+  link: "https://lists.xenproject.org/cgi-bin/mailman/listinfo/xen-devel"
+  linkText: Info
+  secondaryLink: "https://lists.xenproject.org/archives/html/xen-devel"
+  secondaryLinkText: Archives
+
+- title: XEN-CHANGELOG@
+  tags:
+    - Mailing list
+  description: This is a receive-only list to which details of changesets to the Xen Hypervisor Git repositories are sent.
+  link: "https://lists.xenproject.org/cgi-bin/mailman/listinfo/xen-changelog"
+  linkText: Info
+  secondaryLink: "https://lists.xenproject.org/archives/html/xen-changelog"
+  secondaryLinkText: Archives
+{{</row-from-list>}}
+
+
+{{<row cols="3" class="mg-v-lg">}}
+{{<col>}}
+  {{<md>}}
+  ### Mirage OS
+  {{</md>}}
+  {{<row-from-list component="card" component-class="card--bg" titleLevel="2" cols="1" class="mg-t-md align-flex-start">}} 
+  - title: MIRAGEOS-DEVEL@
+    tags:
+      - Mailing list
+    description: A discussion list for the Mirage OS developer community. Note that most development discussion happens on the respective GitHub (via issues, etc. on the respective repositories).
+    link: "https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel"
+    linkText: Info
+    secondaryLink: "https://lists.xenproject.org/archives/html/mirageos-devel"
+    secondaryLinkText: Archives
+  {{</row-from-list>}}
+{{</col>}}
+{{<col>}}
+  {{<md>}}
+  ### Unikraft
+  {{</md>}}
+  {{<row-from-list component="card" component-class="card--bg" titleLevel="2" cols="1"  class="mg-t-md align-flex-start">}} 
+  - title: MINIOS-DEVEL@ (INCLUDES UNIKRAFT DEVELOPMENT) 
+    tags:
+      - Mailing list
+    description: A discussion list for MiniOS and Unikraft development.
+    important: For patches that need to go into hypervisor/mainline please keep an eye on xen-devel. For development discussions that are MiniOS and Unikraft specific, but impact the hypervisor and/or other sub-projects, please CC the relevant mailing list. For Unikraft code submissions please use the prefix [UNIKRAFT PATCH] xxx, whereas for MiniOS use [PATCH xxx].
+    link: "https://lists.xenproject.org/cgi-bin/mailman/listinfo/minios-devel"
+    linkText: Info
+    secondaryLink: "https://lists.xenproject.org/archives/html/minios-devel"
+    secondaryLinkText: Archives
+  {{</row-from-list>}}
+{{</col>}}
+{{<col>}}
+  {{<md>}}
+  ### XAPI
+  {{</md>}}
+  {{<row-from-list component="card" component-class="card--bg" titleLevel="2" cols="1"  class="mg-t-md align-flex-start">}} 
+  - title: XEN-API@
+    tags:
+      - Mailing list
+    description: A discussion list for the XAPI project, developing an open-source management layer for Xen-based systems. The list is both for developers and users.
+    note: Note that most technical discussions for the Xen-API project happen on GitHub (via issues, etc. on the respective repositories).
+    link: "https://lists.xenproject.org/cgi-bin/mailman/listinfo/xen-api"
+    linkText: Info
+    secondaryLink: "https://lists.xenproject.org/archives/html/xen-api"
+    secondaryLinkText: Archives
+  {{</row-from-list>}}
+{{</col>}}
+{{</row>}}
+
+
+{{<md>}}
+### XCP-ng
+{{</md>}}
+{{<row-from-list component="card" component-class="card--bg" titleLevel="2" cols="3" class="mg-t-md align-flex-start">}} 
+- title: XCP-NG FORUMS
+  tags:
+    - Forum
+  description: Announcements related to the project. These may be release announcements, security advisories, announcements related to events. This is a low volume list, with about 1-2 posts per month.
+  link: "https://xcp-ng.org/forum/"
+  linkText: All forums
+  secondaryLink: "https://xcp-ng.org/forum/category/7/development"
+  secondaryLinkText: Development
+- title: XCP-NG NEWSLETTER
+  tags:
+    - Newsletter
+  description: This list is for those using and installing the Xen Project software.
+  link: "http://eepurl.com/gtO5-H"
+  linkText: Subscribe
+- title: XCP-ng-dev
+  tags:
+    - Forum
+  description: For developer specific questions and those who want to contribute, this channel is for you, based on XCP-ng forum.
+  link: "https://xcp-ng.org/forum/category/19/xcp-ng"
+  linkText: Info
+{{</row-from-list>}}
+
+
+{{<md class="mg-t-md">}}
+### Windows PV Drivers
+{{</md>}}
+{{<row-from-list component="card" component-class="card--bg" titleLevel="2" cols="3" class="mg-t-md align-flex-start">}} 
+- title: WIN-PV-DEVEL@
+  tags:
+    - Mailing list
+  description: A discussion list for the Windows PV Drivers developer community.
+  link: "https://lists.xenproject.org/cgi-bin/mailman/listinfo/win-pv-devel"
+  linkText: Info
+  secondaryLink: "https://lists.xenproject.org/archives/html/win-pv-devel"
+  secondaryLinkText: Archives
+{{</row-from-list>}}
+    
+
+{{<md class="mg-t-xl">}}
+## Advisory board
+{{</md>}}
+
+{{<row-from-list component="card" component-class="card--bg" titleLevel="2" cols="3" class="mg-v-md align-flex-start">}} 
+- title: ADVISORY-BOARD@
+  tags:
+    - Mailing list
+  description: A discussion list for members of the Xen Project Advisory Board. The list is invite-only.
+  link: "http://wiki.xenproject.org/wiki/Category:Advisory_Board"
+  linkText: Info
+{{</row-from-list>}}
+
+
+
+{{<md class="mg-t-xl">}}
+## Predisclosure
+{{</md>}}
+
+{{<row-from-list component="card" component-class="card--bg" titleLevel="2" cols="3" class="mg-v-md align-flex-start">}} 
+- title: PREDISCLOSURE-APPLICATIONS@
+  tags:
+    - Mailing list
+  description: |
+    Organizations who want to become a member of the Xen Project predisclosure list to receive pre-disclosure of security advisories and who meet the criteria outlined in the Xen Security Problem Response Process should become members of this mailing list and submit their application through this mailing list as outlined in Xen Security Problem Response Process.
+    
+    The list is open to all community members who care about security and although pre-disclosure membership applications are evaluated based on strict criteria, all applications are open for review and comment by community members. The list is also archived.
+  link: "https://lists.xenproject.org/cgi-bin/mailman/listinfo/predisclosure-applications"
+  linkText: Info
+  secondaryLink: "https://lists.xenproject.org/archives/html/predisclosure-applications"
+  secondaryLinkText: Archives
+
+{{</row-from-list>}}
+{{</section>}}
+
index 9dc183fc128e65306fed3249d947224923dfb4dd..83d7bbc6b638d519c35fd5d97430b00e3d4caab8 100644 (file)
@@ -18,6 +18,7 @@ The `media-block` is a flexible component for displaying content with a media el
   class="bg-light border-rounded"
   animate="true"
 >}}
+{{<md>}}
   ## A remarkable innovation
 
   Our revolutionary new technology improves productivity by **50%**.
@@ -26,7 +27,7 @@ The `media-block` is a flexible component for displaying content with a media el
   * Optimized performance
   * Intuitive interface
   * Maximum compatibility
-
+{{</md>}}
   <div class="mt-4">
     <a href="/demo" class="btn btn-primary">
       Request a demo <i class="fas fa-arrow-right"></i>
@@ -49,4 +50,6 @@ The `media-block` is a flexible component for displaying content with a media el
 | `class`               | string | -             | Additional CSS classes for block                                                                                                                                                |
 | `animate`             | string | "false"       | Activates block animation: `"true"` or `"false"`                                                                                                                                |
 
-The content between the shortcode tags can include Markdown and HTML.
\ No newline at end of file
+The content between the shortcode tags can include Markdown and HTML.
+
+TODO: ajoute un paragraphe qui explique l'utilisation du tag md dans la partie texte du meidablock
\ No newline at end of file
index 894117276c599a8f7129c205dfd6b785ada28096..3bb36f7ad4ec04c46b19ca313963ea950036e84b 100644 (file)
@@ -1,7 +1,13 @@
 # Documentation
 
+## TODO:
+
+- [ ] Ajouter une page a propos des sections ou alors mettre la page dans la partie page editing
+
 ## Links
 
+- [Tutorial](tutorial.md)
 - [Page editing](page-editing.md)
 - [Page advanced editing](page-advanced-editing.md)
-- [Components](page-components.md)  
\ No newline at end of file
+- [Components](page-components.md)  
+
diff --git a/docs/tutorial.md b/docs/tutorial.md
new file mode 100644 (file)
index 0000000..251a132
--- /dev/null
@@ -0,0 +1,109 @@
+# Hugo Tutorial
+
+This tutorial will guide you through the essential aspects of creating and managing content in Hugo, including page creation, block management, image handling, and Markdown basics.
+
+## Creating a New Page
+
+To create a new page in Hugo, follow these steps:
+
+1. Navigate to the `content` directory of your Hugo project
+2. Copy the template.md file in the content directory
+3. rename the markdown file and place it in the section you want
+4. Modify the front matter at the top of your file:
+   ```yaml
+   ---
+   title: "My New Page"
+   description: ""
+   keywords: 
+   draft: false
+   ---
+   ```
+5. Add your content below the front matter
+
+## Adding Blocks
+
+To add blocks to your pages:
+
+1. blocks of a page are always inside `{{<section>}}` block
+  ```markdown
+    {{<section>}}   
+      content
+    {{</section>}}
+  ```
+2. Common components types:
+
+All Component can be seen in the page docs/page-components.md
+   
+
+3. Image placement:
+   - Store images in the `static/img` directory
+   - Reference them using absolute paths : `/img/<subfolder>/<filename>`
+   
+
+## Writing in Markdown
+
+You can write in markdown in the content of components. If sometimes it doesn't work, you can use the tag `{{<md>}} {{</md>}}` to wrap your markdown code.
+
+Here's a quick reference for common Markdown syntax:
+
+### Headers
+```markdown
+# H1 Header
+## H2 Header
+### H3 Header
+```
+
+### Text Formatting
+```markdown
+*Italic text*
+**Bold text**
+***Bold and italic text***
+~~Strikethrough~~
+```
+
+### Lists
+```markdown
+- Unordered list item
+- Another item
+  - Nested item
+
+1. Ordered list item
+2. Second item
+   1. Nested ordered item
+```
+
+### Links
+```markdown
+[Link text](https://example.com)
+[Internal link]({{< ref "/posts/my-post.md" >}})
+```
+
+### Code Blocks
+````markdown
+```python
+def hello_world():
+    print("Hello, World!")
+```
+````
+
+### Tables
+```markdown
+| Header 1 | Header 2 |
+| -------- | -------- |
+| Cell 1   | Cell 2   |
+| Cell 3   | Cell 4   |
+```
+
+### Blockquotes
+```markdown
+> This is a blockquote
+> Multiple lines
+```
+
+Remember to:
+- Use preview mode in your editor to check formatting
+- Keep your Markdown clean and consistent
+- Follow your project's style guide
+- Test your pages locally before publishing
+
+For more advanced features, consult the [Hugo documentation](https://gohugo.io/documentation/).
index f22906161e8c6f2fc17d6ff34b5dbe1913046e0c..913f2c751ffeca397ce5ddca093072a16c57c1d3 100644 (file)
@@ -54,7 +54,9 @@
       "animated-home-shadow-screen",
       "article",
       "background-curve-reverse-top",
+      "bg-light",
       "block-space",
+      "border-rounded",
       "box-resources",
       "box-resources__title",
       "btn",
       "mg-v-xxl",
       "mob-mg-v-xl",
       "mt-2",
+      "mt-4",
       "next",
       "no-mt",
       "p1-book",
       "socials",
       "socials-footer",
       "tag",
+      "text-primary",
       "title-external-link",
       "title-with-gradient-underline",
       "txt-c",
       "youtube-video-container"
     ],
     "ids": [
+      "a-remarkable-innovation",
       "a-virtualization-revolution",
       "advisory-board",
       "archivation-review",