Vald WebSite

Vald WebSite repository based on HUGO.

Document Tree

• Vald WebSite is developed based on HUGO, which is one of the popular site generator.
  If you don't know about HUGO, please read the official document at first.

.
├ archetypes                 // content front matter deffinition
├ config                     // config file for each environment
| ├ _default/config.toml
| ├ staging/config.toml 
| └ production/config.toml 
├ content
| └ docs                     // public document content
|   ├ index.html             // index.html 
|   ├ overview               // overview document directory (latest version) 
|   ├ tutorial               // tutorial document directory (latest version)
|   ├ ...                    // another document directory (latest version) 
|   └ v{major.minor}         // document directory for each release version
├ preview                    // build pages for staging (submodule of vdaas/web/gh-pages)
├ public                     // build pages for production (submodule of vdaas/vald/gh-pages)
├ static                     // static files (img, css, js) for content
| └ images
|   ├ *.(png/svg)            // image files (latest version) 
|   └ v{major.minor}         // image files directory for each release version
└ themes                     // hugo themes

Requirements

• Hugo: v0.0.69~

How to develop

• When you'd like to update config, design, template, etc, we recommend to develop using make run command which you can check on your browser https://localhost:1313

How to get the latest contents

• You can get the latest contents of Vald by below

  $ make all

  The details of progress init.sh:

  1. check latest version.
  2. get the latest Vald package from vdaas/vald and unpacking it.
  3. make sure directory for create contents and static files.
  4. create contents at content root directory (/content/docs) and latest version directory (/content/docs/{version}).
  5. create static files at static root dir (/static/{type}) and latest version dir (/static/{type}/{version}).
  6. correct internal content link and static files' path in each content files (markdown files).

Deploy to staging environment

NOTE:

Before deploy to a staging environment, please check that there are some contents files and static files.

• When you'd like to create the Pull Request or check update, we recommend you deploy to a staging environment. The deployment for stage env will be done when you create the PR. If the deployment via Github Actions ends with failed, please deploy manually from local as below command.

  // build files using Vald for stage env
  $ make build/stage
  
  // deploy to stage env
  $ make deploy/stage

  We can check at Vald Netlify

Deploy to production environment

NOTE:

Before publishing to official WebSite, YOU MUST CHECK the Draft value of each content file.
The content whose draft value is true WILL NOT BE PUBLISHED.
You can change draft variable by below commands (You can choose the most suit command).

# the draft value of all content in the root directory and the latest version directory will be `false`
$ make publish/all

# the draft value of all content in the root directory will be `false`
$ make publish/root

# the draft value of all content in the latest version directory will be `false`
$ make publish/version

• When you'd like to publish the latest Vald WebSite, please create the PR and merge it whose message is contains "release". If the deploy is failed, please deploy by below command.

  // build files using Vald for production env
  $ make build/production
  
  // deploy to production env
  $ make deploy/production

  We can check at Vald Official WebSite