Skip to content

add docker development workflow#3738

Merged
knative-prow-robot merged 2 commits into
knative:mkdocsfrom
csantanapr:issue-3664-docker-dev
Jun 8, 2021
Merged

add docker development workflow#3738
knative-prow-robot merged 2 commits into
knative:mkdocsfrom
csantanapr:issue-3664-docker-dev

Conversation

@csantanapr
Copy link
Copy Markdown
Member

Closes #3664

Provides a simple workflow for mkdocs

Do once to build the container

npm run dev:build

To start working on docs (instant livereload using a container)

npm run dev

When done working on docs

npm run dev:stop

cc @abrennan89 @RichardJJG @snneji

/kind mkdocs
/assign @julz
/assign @omerbensaadon

Signed-off-by: Carlos Santana <csantana23@gmail.com>
@google-cla google-cla Bot added the cla: yes Indicates the PR's author has signed the CLA. label Jun 5, 2021
@knative-prow-robot knative-prow-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 5, 2021
@netlify
Copy link
Copy Markdown

netlify Bot commented Jun 5, 2021

✔️ Deploy Preview for dev-knative ready!

🔨 Explore the source changes: c0f038c

🔍 Inspect the deploy log: https://app.netlify.com/sites/dev-knative/deploys/60badedb7933ca0008d85932

😎 Browse the preview: https://deploy-preview-3738--dev-knative.netlify.app

Signed-off-by: Carlos Santana <csantana23@gmail.com>
Copy link
Copy Markdown
Contributor

@julz julz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to check I understand the reasoning, could we not ship a pre-built docker image with the deps installed and avoid docs writers having to have node/npm installed (and the build step)?

@csantanapr
Copy link
Copy Markdown
Member Author

Just to check I understand the reasoning, could we not ship a pre-built docker image with the deps installed and avoid docs writers having to have node/npm installed (and the build step)?

No reason why we can't use a prebuilt image. How do I do that in this PR?

@omerbensaadon
Copy link
Copy Markdown

omerbensaadon commented Jun 7, 2021 via email

@csantanapr
Copy link
Copy Markdown
Member Author

A pre-built image is a good idea, we just need to work with someone that knows how the infra/prow works to be able to push an image with a nightly job

I propose we merge this PR and an issue is already created for the pre-built image #3664

Copy link
Copy Markdown
Contributor

@julz julz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll figure out the image later since we need to work out what repo to put it in

/lgtm

@knative-prow-robot knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Jun 8, 2021
@omerbensaadon
Copy link
Copy Markdown

/approve

@knative-prow-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: csantanapr, julz, omerbensaadon

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:
  • OWNERS [csantanapr,julz,omerbensaadon]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@knative-prow-robot knative-prow-robot merged commit b5bb374 into knative:mkdocs Jun 8, 2021
RichardJJG pushed a commit to RichardJJG/docs that referenced this pull request Jul 1, 2021
* add docker development workflow

Signed-off-by: Carlos Santana <csantana23@gmail.com>

* adding pesky EOL

Signed-off-by: Carlos Santana <csantana23@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cla: yes Indicates the PR's author has signed the CLA. kind/mkdocs lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create a Docker image for contributor use

4 participants