Skip to content
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

Jump to bottom

Create default "Contributing to the docs" README from docusaurus-init #246

Closed
JoelMarcey opened this issue Nov 30, 2017 · 2 comments
Closed

Create default "Contributing to the docs" README from docusaurus-init #246

JoelMarcey opened this issue Nov 30, 2017 · 2 comments
Labels
difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin.

Comments

@JoelMarcey
Copy link
Contributor

JoelMarcey commented Nov 30, 2017 •
edited
Loading

README will have content such as:

  • prereqs
  • running locally
  • directory structure
  • configuration

Much of the README may be able to link to the docusaurus.io docs instead of repeating within the README itself. We can see.
@neilsutcliffe
Copy link
Contributor

neilsutcliffe commented Dec 17, 2017 •
edited
Loading

With regard to running locally, I found a few issues.

Cloning the repo directly, there will not be any translated files. Since the crowdin API key isn't included, then these files can't be downloaded either. I had to go ahead and remove this line to get it to work temporarily

{ doc: "installation", label: "Docs" },

Also, the package.json has the following line

"start": "../lib/start-server.js",

which I had to change to the following

"start": "node ../lib/start-server.js",

#304

@JoelMarcey JoelMarcey changed the title Create default "Contributing to the docs" README from init-script Create default "Contributing to the docs" README from docusaurus-init Feb 27, 2018
@JoelMarcey JoelMarcey added the feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. label Feb 27, 2018
@endiliey endiliey added the good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. label Jun 2, 2018
@endiliey endiliey added the difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. label Jun 18, 2018
@endiliey
Copy link
Contributor

Duplicate #925

@jaril jaril mentioned this issue Aug 30, 2018
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@JoelMarcey @neilsutcliffe @endiliey