Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Create CI jobs for docs

See original GitHub issue

We need a nightly and manual shipping CI job that pulls the docs from codenvy/codenvy-docs and pushes them so that they’re published at codenvy.com/docs or codenvy.com/docs-version. Serhii has the login information for the codenvy.com server.

@JamesDrummond please confirm but I believe we will end up with 4 docs locations on codenvy.com:

codenvy.com/docs will show the main index.html page which includes redirect links for the other locations.
codenvy.com/docs-version/nightly will show the docs built from nightly
codenvy.com/docs-version/5.0.0 will show the docs for a release (e.g. 5.0.0 / 5.1.0 / etc…)
codenvy.com/docs-version/latest is a convenient link to the latest of the release docs listed in 3

This job should also be able to be run manually at any other time.

Step-by-step

Nightly:

Create new folders “nightly/docs” if not existing at https://codenvy.com/docs-version/nightly/docs .
Remove content of https://codenvy.com/docs-version/nightly/docs/* .
Upload content of target/codenvy-docs-<version>/ into https://codenvy.com/doc-version/nightly/docs/ .

Shipped version:

Create new folders “<version>/docs” at https://codenvy.com/docs-version/<version>/docs .
Upload content of target/codenvy-docs-<version>/ into https://codenvy.com/docs-version/<version>/docs/ .
Remove content of https://codenvy.com/docs/* .
Upload content of target/codenvy-docs-<version>/ into https://codenvy.com/docs/.

Issue Analytics

State:
Created 7 years ago
Comments:14 (4 by maintainers)

Top GitHub Comments

1reaction

riuvshincommented, Jan 20, 2017

Done.

@bmicklea @JamesDrummond please note now we should use only CI to update docs. guys please add somewhere in docs version of docs that will make life easier to make sure that proper docs are deployed.

https://codenvy.com/docs/ now updated to 5.1.0 also I;ve added all tags here https://codenvy.com/docs-version/5.0.0/docs/index.html https://codenvy.com/docs-version/5.0.1/docs/index.html https://codenvy.com/docs-version/5.1.0/docs/index.html

and nightly (nightly will be updated every day) https://codenvy.com/docs-version/nightly/docs/index.html

0reactions

JamesDrummondcommented, Jan 19, 2017

@riuvshin Per our meeting is this issue clear for you. If so can you update docs on website with 5.1.0?

Top Results From Across the Web

Jobs - GitLab Docs

View all jobs in a project · On the top bar, select Main menu > Projects and find the project. · On the...

CI/CD with Google Cloud

Create a continuous integration and delivery (CI/CD) pipeline on Google Cloud Platform using Cloud Build, our hosted product suite, and the popular GitOps ......

Configuring CircleCI

CircleCI supports running jobs on macOS , to allow you to build, test, and deploy apps for macOS, iOS , tvOS and watchOS...

Workflow syntax for GitHub Actions

A workflow is a configurable automated process made up of one or more jobs. You must create a YAML file to define your...

Job Lifecycle - Travis CI Docs

install - install any dependencies required; script - run the build script. Travis CI can run custom commands in the phases: before_install -...