fbeaudoincoveo / cloudv2-docs-site Goto Github PK

#READ ME

1. Fork the repository locally.

2. Install Jekyll.

   The Coveo Docs Site is generated with Jekyll, so you must install Jekyll and its requirements such as Ruby. Tom Johnson's installation procedure work:

   • Install Jekyll on Mac
   • Install Jekyll on Windows

3. Intall html-proofer to allow testing external links in the content:

   gem install html-proofer

4. Install s3_website to be able to push to AWS S3:

   gem install s3_website

Build the site locally to validate your changes:

1. In the terminal:

   1. Go to the repository root folder.

   2. Run bundle exec jekyll serve --incremental

      Tip: You can also use the defined Visual Studio Code task Jekyll - Build Prod incremental:

      1. In Visual Studio Code, open the Command Palette (shift+ cmd+ 'P').
      2. In the Command Palette, type tasks and then select Tasks: Run tasks.
      3. In the drop-down list, select Jekyll - Build Prod incremental.
      4. In the drop-down list, select Never scan the task output. A TERMINAL window opens and the command to build the Jekyll site locally starts.

      Alternate commangs:

      • If you want sitemap.xml links to contain the production hostname (not localhost:4000), run:

      JEKYLL_ENV=production bundle exec jekyll serve --incremental

      The default value is JEKYLL_ENV=development (see Specifying a Jekyll environment at build timePermalink).

      • If baseurl was not empty in _config.yml and you want to the local site to start from the root, run:

      bundle exec jekyll serve --baseurl '' --incremental

2. In a browser, go to http://localhost:4000/ to view the site.

3. Make your changes to the site.

4. Validate your changes in the local site.

5. In the terminal, run the HTML-Proofer to validate links, images, scripts and more are working .

   htmlproofer --assume-extension --allow-hash-href --alt-ignore --check-external-hash ./_site

   Options:

   • --assume-extension adds .html extensions to extensionless paths
   • --allow-hash-href ignores the <a href="#" ..>occurrences
   • --alt-ignore safely ignore image missing alt attributes
   • --check-external-hash check bookmarks in external links (can slow down the check)

6. In the terminal, run the s3_website command to push changes to the S3 coveo-products-docs bucket: s3_website push

7. Make a pull request to propose your changes.

See CONTRIBUTING-CONTENT.md