Deploy Compodoc documentation on GitLab without using GitLab Pages

Question

Dear fellow developers,

I'd like to deploy our Compodoc documentation to GitLab in order to make it available to every developer within our team (like an API page).

According to the company I'm working for, I can't use GitLab Pages for this.

Any ideas?

Any help is appreciated

Answer 1

The company I am working for does not allow GitLab pages for some reason. So I had to come up with another solution.

Please keep in mind that I was looking for a way to make the documentation accessible to every developer.

In order to do so, I basically had to make two steps:

1. Modify package.json

   "docgen": "./node_modules/.bin/compodoc -p src/tsconfig.app.json",

   "doc:buildandserve": "compodoc -p src/tsconfig.app.json -s",

   "bundle-report": "webpack-bundle-analyzer dist/stats.json"

   This will build and serve the documentation wherever it is deployed.

2. Modify build pipeline

   I had to insert an extra step within my pipe to execute the above code so that developers can access the documentation like http:\\www.your-applications-url.com\documentation

Hope this helps.