Reference, Troubleshooting

Use this page if you are having issues building the site, previewing, or submitting content.

Errors building the site

• If you do not have the extended version of hugo installed, you will get an error similar to this when you run make preview:

  hugo server -b http://localhost:1313/developer
  Start building sites …
  ERROR 2021/04/26 14:34:41 TOCSS: failed to transform "css/light-theme.css" (text/x-scss). Check your Hugo installation; you need the extended version to build SCSS/SASS.
  Built in 1366 ms
  Error: Error building site: TOCSS: failed to transform "css/main.css" (text/x-scss). Check your Hugo installation; you need the extended version to build SCSS/SASS.
  make: *** [Makefile:22: preview] Error 255
  

Spelling errors in the automated tests

• If the errors are around a company's name, a person's name, legitimate abbreviation, etc, you can add the word to the custom_dict.txt file at the root of the repository. For multi-word spelling errors, such as with a first name and last name, you can simply append each in the custom_dict.txt file, first name on one line, last name on another. Don't worry about sorting. When you commit the changes, there’s a pre-commit hook that will automatically run that will sort the new entries alphabetically.

• If the errors are around a library or method name, try wrapping the word or phrase in an in-line code fragment, or in a code block. This is in accordance with the TDC style guide and the spell checker will ignore words in code formatting. Do not add these words to custom_dict.txt.

  Put method names, tools, or CLI commands into `inLineCodeFormatting` like this.
  
  Or into 
  "```
  a 
  code block
  like this
  ```"
  

Authentication errors opening the pull request

• Errors such as the following are likely due to trying to open a pull request when working on a branch directly on the tanzu-dev-portal repository. Instead, you probably need to fork the repo into your own GitHub account, make changes, then open the pull request to the tanzu-dev-portal repository from there.

  remote: Permission to vmware-tanzu/tanzu-dev-portal.git denied to <user>.
  fatal: unable to access 'https://github.com/vmware-tanzu/tanzu-dev-portal.git/': The requested URL returned error: 403