[documentation (deploy)] deploy docsify in docker. by Koooooo-7 · Pull Request #1241 · docsifyjs/docsify

Koooooo-7 · 2020-06-22T15:51:54Z

Summary
A toturial about building docsify in docker.
Docker is getting more popular, so I wanna rich the deploy ways for docsify.

What kind of change does this PR introduce? (check at least one)

If changing the UI of default theme, please provide the before/after screenshot:

Does this PR introduce a breaking change? (check one)

Yes
No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

If adding a new feature, the PR's description includes:

A convincing reason for adding this feature
Related documents have been updated
Related tests have been updated

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

Other information:

DO NOT include files inside lib directory.

vercel · 2020-06-22T15:51:58Z

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/docsify-core/docsify-preview/gfuhxhs2l
✅ Preview: https://docsify-preview-git-fork-koooooo-7-docker-doc.docsify-core.vercel.app

codesandbox-ci · 2020-06-22T15:56:44Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 682330e:

Sandbox	Source
naughty-carson-q4oki	Configuration

docs/deploy.md

trusktr

Good to provide people some options/ideas. Do we want to provide a boilerplate repo ready for Docsify?

jhildenbiddle · 2020-06-22T17:38:18Z

docs/deploy.md

+
+## Docker
+
+>There is a simple demo for building docsify in docker.


Can we remove this? I'm not sure why this is here (or why it's formatted using a blockquote)

yep, it is unnecessary.

jhildenbiddle · 2020-06-22T17:44:38Z

docs/deploy.md

+
+>There is a simple demo for building docsify in docker.
+
+?> tips: you can create all the files for this demo from [Quickstart](https://docsify.js.org/#/quickstart?id=initialize).


The link to the Quickstart should be provided under the docsify bullet below, not above it. Otherwise, this tip implies "all of the files for this demo" including a docker file, which the Quickstart section does not discuss. Recommend removing this and just adding a link (not a tip) under the docsify bullet below.

jhildenbiddle · 2020-06-22T17:45:17Z

docs/deploy.md

+
+?> tips: you can create all the files for this demo from [Quickstart](https://docsify.js.org/#/quickstart?id=initialize).
+
+- Preparing Docsify initial files  


Making bullet names consistent: "Create docsify files"

jhildenbiddle · 2020-06-22T17:48:20Z

docs/deploy.md

+?> tips: you can create all the files for this demo from [Quickstart](https://docsify.js.org/#/quickstart?id=initialize).
+
+- Preparing Docsify initial files  
+  You need prepare the initial files (generated by run `docsify init ./docs`) instead of making in container.


To prevent outdated instructions here, let's just refer people to the Quickstart guide: "See the Quickstart section for instructions on how to create these files manually or using docsify-cli."

(Quickstart section and docsify-cli should be linked)

jhildenbiddle · 2020-06-22T17:48:56Z

docs/deploy.md

+  README.md
+  ```
+
+- Dockerfile


Making bullet names consistent: "Create dockerfile"

jhildenbiddle · 2020-06-22T17:49:30Z

docs/deploy.md

+   Dockerfile
+  ```
+
+- Build Image


Making bullet names consistent: "Build docker image"

jhildenbiddle · 2020-06-22T17:50:14Z

docs/deploy.md

+  docker build -f Dockerfile -t docsify/demo .
+  ```
+
+- Run


Making bullet names consistent: "Run docker image"

jhildenbiddle

Looks great!!

jhildenbiddle · 2020-06-23T04:23:14Z

Nice work, @Koooooo-7. Thanks for being patient with all of the change requests. :)

Koooooo-7 · 2020-06-23T14:17:27Z

boilerplate

yep, I agree.
I stored it in my own repo.
As @jhildenbiddle mentioned, its not a good idea to handle another resource outside.
so , we can think about if we need build a resource repo to provide those

Nice work, @Koooooo-7. Thanks for being patient with all of the change requests. :)

Glad to make it concise and accurate . xD

* develop: docs: removed codefund docs and plugin (#1262) docs: remove bundle size from the home page and documentation (#1257) fix: search can not search the table header (#1256) fix: after setting the background image, the button is obscured (#1234) Fix: fixed onlycover flag in mobile (#1243) fix: Updated docs with instructions for installing specific version (fixes #780) (#1225) fix: Add error handling for missing dependencies (fixes #1210) (#1232) [documdocs: deploy docsify in docker. (#1241) docs: Add embed gist instructions to Embed Files (fixes #932 ) (#1238) chore: add changelog 4.11.4 [build] 4.11.4 feat: added html sanitizer for remote rendering (#1128)

[documentation deploy] deploy docsify in docker.

5015970

vercel bot deployed to Preview June 22, 2020 15:51 View deployment

Koooooo-7 requested review from anikethsaha, jhildenbiddle, sy-records and trusktr June 22, 2020 15:52

vercel bot deployed to Preview June 22, 2020 15:53 View deployment

jhildenbiddle requested changes Jun 22, 2020

View reviewed changes

docs/deploy.md Outdated Show resolved Hide resolved

docs/deploy.md Outdated Show resolved Hide resolved

docs/deploy.md Outdated Show resolved Hide resolved

docs/deploy.md Outdated Show resolved Hide resolved

docs/deploy.md Outdated Show resolved Hide resolved

[remove] remove unnecessary content.

2d4fca4

vercel bot deployed to Preview June 22, 2020 16:22 View deployment

[change] remove outbox resource link.

32d768d

vercel bot deployed to Preview June 22, 2020 16:28 View deployment

Koooooo-7 requested a review from jhildenbiddle June 22, 2020 16:31

trusktr previously approved these changes Jun 22, 2020

View reviewed changes

anikethsaha previously approved these changes Jun 22, 2020

View reviewed changes

vercel bot deployed to Preview June 22, 2020 17:35 View deployment

vercel bot deployed to Preview June 22, 2020 17:42 View deployment

jhildenbiddle requested changes Jun 22, 2020

View reviewed changes

[refine] refine description.

bcd06d5

Koooooo-7 dismissed stale reviews from anikethsaha and trusktr via bcd06d5 June 23, 2020 01:11

vercel bot deployed to Preview June 23, 2020 01:11 View deployment

sy-records approved these changes Jun 23, 2020

View reviewed changes

jhildenbiddle approved these changes Jun 23, 2020

View reviewed changes

Merge branch 'develop' into docker/doc

682330e

vercel bot deployed to Preview June 23, 2020 06:52 View deployment

anikethsaha merged commit 4b02177 into docsifyjs:develop Jun 23, 2020


		## Docker

		>There is a simple demo for building docsify in docker.


		>There is a simple demo for building docsify in docker.

		?> tips: you can create all the files for this demo from [Quickstart](https://docsify.js.org/#/quickstart?id=initialize).


		?> tips: you can create all the files for this demo from [Quickstart](https://docsify.js.org/#/quickstart?id=initialize).

		- Preparing Docsify initial files

Uh oh!

Conversation

Koooooo-7 commented Jun 22, 2020

Uh oh!

vercel bot commented Jun 22, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codesandbox-ci bot commented Jun 22, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

trusktr left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jhildenbiddle left a comment

Choose a reason for hiding this comment

Uh oh!

jhildenbiddle commented Jun 23, 2020

Uh oh!

Koooooo-7 commented Jun 23, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

vercel bot commented Jun 22, 2020 •

edited

Loading

codesandbox-ci bot commented Jun 22, 2020 •

edited

Loading