README.md

hyperformula-staging

Repository required to deploy HF documentation to staging env (GH pages).

Staging env

URL

https://handsontable.github.io/hyperformula-staging/

SEO

The page is protected from being indexed by the search engine bots by:

• https://handsontable.github.io/robots.txt
• <meta name="robots" content="noindex, nofollow"> in https://handsontable.github.io/hyperformula-staging/index.html file

GH does not support restricting access to it using a password

How to deploy documentation to staging

If you want to deploy the documentation from feature-branch (in the hyperformula repo), follow these steps:

1. Create a pull request across forks (this link might help):
   • to [base repo] hyperformula-staging, [base branch] hyperformula
   • from [head repo] hyperformula, [head branch] feature-branch
2. Make sure it does not overwrite the key code fragments (see below)
3. Merge the PR
4. Wait for Publish and pages-build-deployment workflows to finish
5. Visit https://handsontable.github.io/hyperformula-staging/

Key code fragments

In hyperformula branch there are a few code fragments that are essential for correct deployment of the staging env. They must not be overwritten.

1. File .github/workflows/publish.yml, especially the specification of the branch that triggers the workflow:

   hyperformula-staging/.github/workflows/publish.yml

   Lines 3 to 6 in 28116bf

   	on:
   	push:
   	branches:
   	- hyperformula

2. Spacification of the base URL in the docs/.vuepress/config.js file:

   hyperformula-staging/docs/.vuepress/config.js

   Line 65 in 28116bf

   base: '/hyperformula-staging/',

3. <meta name="robots"> tag in the docs/.vuepress/config.js file:

   hyperformula-staging/docs/.vuepress/config.js

   Lines 15 to 16 in 28116bf

   	// Robots for staging: noindex, nofollow
   	['meta', {name: 'robots', content: 'noindex, nofollow'}],