kubeedge / website

KubeEdge website and documentation repo:

Creating and updating the KubeEdge docs

Welcome to the GitHub repository for KubeEdge's public website. The docs are hosted at https://kubeedge.io.

We use Docusaurus to format and generate our website, and Netlify to manage the deployment of the site. Docusaurus is an open-source static site generator that provides us with templates, content organisation in a standard directory structure, and a website generation engine. You write the pages in Markdown, and Docusaurus wraps them up into a website.

• Please see How to contributing for instructions on how to contribute, if you are not familiar with the GitHub workflow
• Start contributing

Quick start

Here's a quick guide to updating the docs. It assumes you're familiar with the GitHub workflow and you're happy to use the automated preview of your doc updates:

1. Fork the [KubeEdge/website repo][kubeEdge-website-repo] on GitHub.
2. Make your changes and send a pull request (PR).
3. If you're not yet ready for a review, add a comment to the PR saying it's a work in progress or add [WIP] in your PRs title. You can also add /hold in a comment to mark the PR as not ready for merge.
4. Wait for the automated PR workflow to do some checks. When it's ready, you should see a comment like this: deploy/netlify — Deploy preview ready!
5. Click Details to the right of "Deploy preview ready" to see a preview of your updates.
6. Continue updating your doc until you're happy with it.
7. When you're ready for a review, add a comment to the PR and assign a reviewer/approver. See the [Kubeedge contributor guide][kubeedge-contributor-guide].

Previewing your changes on a local website server

If you'd like to preview your doc updates as you work, you can install Node.js and run a local server. This section shows you how.

Install Node.js

Node.js version 16.14 or above (which can be checked by running node -v). You can use nvm for managing multiple Node versions on a single machine installed.

Install yarn

npm install -g yarn

Install dependencies

cd website

yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Your website is at http://localhost:3000/

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Versioning

For each stable release, we should create a new branch for the relevant documentation. For example, the documentation for the v0.1 stable release are maintained in the v0.1-branch. Each branch has a corresponding netlify website that automatically syncs each merged PR.

Going forward, the versioned sites should follow this convention:

• https://kubeedge.netlify.com/ always points to the current master branch
• https://master.kubeedge.netlify.com/ always points to Github head
• https://vXXX-YYY.kubeedge.netlify.com/ points to the release at vXXX.YYY-branch

website's Issues

Clicking on the Learn More button on home slider takes user to a different doc

The KubeEdge documentation is now moved to https://docs.kubeedge.io.
The Learn More About KubeEdge button on the home slider still points to older documentation.

testing bot 111

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.

Developer onboarding documentation missing

What would you like to be added/modified: Currently this page is empty: https://kubeedge.io/en/docs/developer/build/

Why is this needed: It should describe pre-requisites and a basic development workflow for contributors

Support return the latest version number in the response when user curls the URL

Is your feature request related to a problem? Please describe.
If the user curls the URL the response should be return the latest version number, e.g.

#: curl https://kubeedge.io/latestversion
v1.4.0

New theme and format for the website

Project Description

Redesign and reimplement the official website to show the key features of KubeEdge.

Difficulty

Medium

Mentor

Kevin Wang(@kevin-wangzefeng): [email protected]

Output

• New website styling
• Key values/features of KubeEdge highlighted in prominent position
• redundant content section removed in homepage
• add support for hosting multiple releases and multi-languages for documents
• add community information including partners, end users, success stories.

Tech. Requirement

• KubeEdge
• css
• website layout

Related Repo

• https://github.com/kubeedge/website

Update docs about keadm install kubeedge

the docs of page https://kubeedge.io/en/docs/setup/keadm/ is out of date, we have move the keadm beta install cmds to GA, and the origin keadm init/join/reset cmds have been moved to keadm deprecated init/join/reset, we need to update instructions

ref:
https://github.com/kubeedge/kubeedge/blob/master/CHANGELOG/CHANGELOG-1.11.md#beta-sub-commands-in-keadm-to-ga
https://github.com/kubeedge/kubeedge/blob/master/CHANGELOG/CHANGELOG-1.11.md#deprecation-of-original-init-and-join
kubeedge/kubeedge#3900

/help
/good-first-issue

Netlify CI is using an unsupported image

Describe the bug
In #177, the CI is failing with the following error:

  UNSUPPORTED BUILD IMAGE

  The build image for this site uses Ubuntu 14.04 Trusty Tahr, which is no longer supported.

  To enable builds for this site, select a later build image at the following link:
  https://app.netlify.com/sites/privatekubeedge/settings/deploys#build-image-selection

  For more details, visit the build image migration guide:
  https://answers.netlify.com/t/end-of-support-for-trusty-build-image-everything-you-need-to-know/39004

**Automation**

Automatically move your cards to the right place based on the status and activity of your issues and pull requests.

Translate documents in content/ko/home/ to Korean.

Is your feature request related to a problem? Please describe.
Translation.

Describe the solution you'd like
There is no Korean documents in this project.
I would like to translate documents in content/ko/home/ to Korean.

Describe alternatives you've considered
Not all documents can be translated at once, but I will continue to translate them step by step.

Additional context

update hugo to last version

https://github.com/kubeedge/website/blob/master/netlify.toml
/assign

Create a tutorials section

• Add tutorials on how to use both the edge and cloud.

• Add tutorials on how to to use kubeedge with Huawei IEF

• Add tutorial with any other cloud provider or orchestration tool.

Create a demos section.

• Give the link to the demo repository.

• Provide a video of the demo.

• Update the demo documentation.

Docs: add Mapper developer guide

Ref kubeedge/kubeedge#1498

Add developer guide about how to implement mapper.

/kind documentation

update links

http=>https
/assign

Docs: add CSI user guide

Ref kubeedge/kubeedge#1498

Add user guide about how to implement and use third party storage with CSI.

/kind documentation

Docs: add Admission user guide

Ref kubeedge/kubeedge#1498

Add user guide about how to Control resources on the edge with Admission.

/kind documentation

DOCS：add software version/_index_zh.md

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

fix Cloud Native logo on mobile & tablet

/assign

update favicons

https://realfavicongenerator.net/favicon_checker?protocol=https&site=kubeedge.io%2Fen%2F#.YkAdPufP23A
for all devices
/assign

Accessibility update social links

https://kubeedge.io/en/blog/release-v1.9/
/assign

Accessibility add link name

/assign

Request to translation for Korean.

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

I would like to translate these documents into Korean.

Can only contributors translate documents?

If not, please tell me the procedure to start translating Korean.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Update documentation section.

• Integration with readthedocs.io

• explore the option of retaining the website style and readthedocs style the same.

Chinese (zh) Translation of website

The new website supports multiple languages.
The chinese content is maintained under the content/zh folder.
Some of the files are already translated using Google Translate but this may not be accurate.
We will need to do the following:

• Identify incorrect translations and fix them.

• Add missing translations

Code of conduct link broken

Describe the bug
The code of conduct link on the documentation site renders a 404 error when trying to access it

To Reproduce
Steps to reproduce the behavior:

1. Go to 'https://kubeedge.readthedocs.io/en/latest/getting-started/contribute.html#getting-started'
2. Click on 'code of conduct'
3. Scroll down to '....'
4. See error '404 this is the web page you looking for'

Expected behavior
The link to be accessible

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [Windows 10]
• Browser [chrome]

Additional context
Add any other context about the problem here.

Add twitter feed and tweets section

• Add a twitter feed that shows engagement with the official twitter handle.

Dark mode information is not remembered by the website

Describe the bug
Dark mode information is not remembered by the website

To Reproduce
Steps to reproduce the behavior:

1. Open the webpage
2. Choose dark mode
3. Refresh the page
4. Dark mode is lost and the webpage fallsback to light mode

Expected behavior
When user chooses dark mode, then whenever the user comes back to the page, it has to be rendered in dark mode

Suggestion
you can use localStorage API of modern browsers to store and retrieve the theme information

localStorage.setItem('theme', 'dark')
localStorage.getItem('theme')

Translate documents in content/ko to Korean

Is your feature request related to a problem? Please describe.
Translate.

Describe the solution you'd like
As version increased to v1.3, I'd like to change the Korean documentation of kubeedge.

fix toggle menu on close

/assign

wrong copyright date

/assign

Clicking on the Home link does not work

On the navigation menu, the Home link should take you to the home slide section of the home page.
Clicking on the menu item does not do anything.

Update docs/

Is your feature request related to a problem? Please describe.

Now we use https://docs.kubeedge.io/en/latest/ rather than https://kubeedge.io/en/docs, while https://kubeedge.io/en/docs/ can be visited, and some docs are outdated like https://kubeedge.io/en/docs/getting-started-minikube/.

Describe the solution you'd like

Use git filter-branch to keep git log and sync docs from kubeedge/kubeedge/docs.

If no need to keep git log, just skip it.

Other problem is that need we keep two docs website?

@kevin-wangzefeng

Docs: add ServiceBus user guide

Ref kubeedge/kubeedge#1498

Add user guide about how to create HTTP services with ServiceBusI.

/kind documentation

social icons ui update

make one line
/assign

Add Blog Section

• Add a blog section to the website.

• Add blog posts.

Docs: add Device CRD user/developer guide

Ref kubeedge/kubeedge#1498

Add guide about how to implement/use Device CRD.

/kind documentation

Code snippet formatting

Don't include the command prompt
Do: mkdir -p /var/lib/kubeedge
Don't: $ mkdir -p /var/lib/kubeedge

Following the docs style guide of kubernetes

The link in kubeedge website missed the '.md' suffix

Describe the bug
now the link in kubeedge website missed the '.md' suffix, Ref: page
But in github it works fine, in kubeedge.io missed '.md' , so lead to a 404 in kubeedge.io.

Noticed have a PR before related to this. #704

Expected behavior
The link works fine.

/cc @anvithks @yamt Could you please help take a look?

"heterogeneous" misspelled on homepage

https://kubeedge.io has a tile that says KubeEdge is "heterogenous." The correct spelling is "heterogeneous." As written, it looks like "hetero" and "erogenous," which implies something entirely different.

Accessibility add link name

/assign

Add CNCF/LF logo and trademark to the site footer

To prep for incubation, the site needs to follow CNCF website guidelines:

• Display the CNCF logo
• Display a trademark statement for the Linux Foundation

Accessibility update "go to top"

arrow
/assign

Docs: add SeviceBus introduction

Ref kubeedge/kubeedge#1498

Add user guide about how to implement and use third party storage with CSI.

/kind documentation

Update Academic theme to latest version v4.1.0

Testing bot please ignore

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...' please ignore
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.

Setup the Huawei CI-Bot on this repository.

update hugo

update hugo to last work version on this theme
/assign

Updating the kubeedge docs

Now we have lots of new features, we need add more docs for them.

Accessibility add alt to image

/assign
Cloud Native Computing Foundation

update content links

http=>https
/assign