Skip to content

[documentation (deploy)] deploy docsify in docker. #1241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 23, 2020
Merged

[documentation (deploy)] deploy docsify in docker. #1241

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5015970
[documentation deploy] deploy docsify in docker.
Koooooo-7 Jun 22, 2020
2d4fca4
[remove] remove unnecessary content.
Koooooo-7 Jun 22, 2020
32d768d
[change] remove outbox resource link.
Koooooo-7 Jun 22, 2020
bcd06d5
[refine] refine description.
Koooooo-7 Jun 23, 2020
682330e
Merge branch 'develop' into docker/doc
anikethsaha Jun 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
[change] remove outbox resource link.
  • Loading branch information
@Koooooo-7
Koooooo-7 committed Jun 22, 2020
commit 32d768d6f03b78edab6e18da0e2b3ef477babde9
2 changes: 1 addition & 1 deletion docs/deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ frontend:

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

Choose a reason for hiding this comment

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

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

Copy link
Member Author

Choose a reason for hiding this comment

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

yep, it is unnecessary.


?> tips: you can get all the files for this demo from [here](https://github.com/Koooooo-7/docsify-docker).
?> tips: you can create all the files for this demo from [Quickstart](https://docsify.js.org/#/quickstart?id=initialize).
Copy link
Member

Choose a reason for hiding this comment

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

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.


- Preparing Docsify initial files
Copy link
Member

Choose a reason for hiding this comment

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

Making bullet names consistent: "Create docsify files"

You need prepare the initial files (generated by run `docsify init ./docs`) instead of making in container.
Copy link
Member

Choose a reason for hiding this comment

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

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)

Expand Down