vmware / vmware/singleton

Add CD to automate documentation website update

Open
#574 0 comments 0 reactions 1 assignee View on GitHub

@gong-yu is already working on this.

Since May 22, 2020.

  • #585 by @gong-yu — merged
area/deployment kind/documentation priority/medium
Dominant language
Java
Stars
72
Forks
69
Avg merge
23h 32m
Merged PRs (30d)
4

Description

Singleton documentation website is built up by Hugo. Though the developers can write documents directly in .md documents without worrying about the style of the website, they also need to install and learn Hugo to publish their documents to the website. Sometimes, the publishing process fails due to developer's local environment problem, however it's hard to debug and find the root cause.

It's better to add CD in Travis to automate the process, so that the website can be automatically updated every time developer merges a PR for their .md document update.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.