This is the repository including all source codes of https://skywalking.apache.org.
This site was compiled using Hugo.
npm install to install the required libraries (without pulling the project documentation).hugo server at the root folder, you can see the site preview from http://localhost:1313npm run build for the whole website. Run npm run build-with-docs if you want to build the project documentations.This guide will guide you on how to contribute to the site.
This site uses Hugo to organize and manage content with the following sections are available:
Located at content/_index.html。
The data of documentation link is located in data/docs.yml and formated as YAML.
Update the config file everytime, so that a new documentation version will be available searched by algolia.
Release managers of SkyWalking projects should use the Kapa.ai dashboard to sync and ingest new documentation/blogs/FAQs if needed, or set up automatic refresh (crawling) of the Q&A sources.
If you need access to the dashboard, contact @superskyyy for an invitation.
Located at content/events. If you don't want to create a new blog, you need to create a new subdirectory under this directory. Here is a sample event below.
--- title: This is a title date: 2020-04-28 author: Author description: This is description. # endTime: 2021-04-24T23:59:59Z # startTime: 2021-04-22T00:00:00Z # buttonText: Go # img: /images/skywalking_200x200.png --- Content
If you want to display the summary in the popover in the lower right corner, you need to configure a parameter endTime. The parameters are as follows.
| Parameter | Description | Required | Default |
|---|---|---|---|
| endTime | End time | true | - |
| startTime | Start time | false | Current time |
| buttonText | Button text | false | Read more |
| img | The illustration | false | /images/skywalking_200x200.png |
| poster | The poster | false | - |
Located at content/blog. If you want to create a new blog, you need to create a new subdirectory under this directory. Here is a sample blog below.
--- title: This is a title date: 2020-04-28 author: Author description: This is description. --- Content
The data of release is located in data/releases.yml and formated as YAML. The data of docker image is located in data/dockerImages.yml and formated as YAML.
This is a single page located at content/team/_index.md.
Located at content/zh. If you want to create a new blog, you need to create a new subdirectory under this directory. Here is a sample blog below.
--- title: 博客标题 date: 2020-04-28 author: 作者姓名 description: 博客摘要 --- 博客正文。
All user information are in /data/users.yml. Users are encouraged to add themselves to this page.
Configure in the config.toml file.
The website configuration file is located at config.toml.
The images within the blogs, events and 中文博客 should be kept at the same folder as the blog file, and you should reference them with the relative path.