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.

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

Add basic docs structure to agent #2

Merged
merged 1 commit into from
Aug 21, 2017
Merged

Conversation

ruflin
Copy link
Member

@ruflin ruflin commented Aug 18, 2017

This is the basic doc structure needed for the elastic docs build. For convenience I added a script that can be executed with npm run docs to build the docs locally to see if the doc build passes and how the docs will look like.

As soon as we have Jenkins added as CI we should also add a build step for npm run docs to make sure we do not break the doc build.

@ruflin ruflin added the review label Aug 18, 2017
@ruflin ruflin requested a review from watson August 18, 2017 11:28
@watson
Copy link
Contributor

watson commented Aug 18, 2017

@ruflin thanks for taking the time to do this 😄

Regarding the Makefile: Yes, in Node.js land we normally use npm to run scripts, e.g. npm run docs. You can read more about that here: https://docs.npmjs.com/cli/run-script

The scripts in the test folder is purely for testing - that's why they are there. So I think it's fine to either create a script folder like you did, or maybe just put the script in the docs folder.

One last thing: When publishing to npm, the npm CLI will not package up files and folders excluded by .gitignore. But if you have things that you want in git, but don't want in the package, you can add it to .npmignore which works just like .gitignore but just for npm. I suggest doing that with both docs and script.

@ruflin ruflin force-pushed the add-docs-build branch 2 times, most recently from baa21d8 to 0276e94 Compare August 18, 2017 14:06
This is the basic doc structure needed for the elastic docs build. For convenience I added a script that can be executed with `npm run docs` to build the docs locally to see if the doc build passes and how the docs will look like.

As soon as we have Jenkins added as CI we should also add a build step for `npm run docs` to make sure we do not break the doc build.
@ruflin
Copy link
Member Author

ruflin commented Aug 18, 2017

@watson

  • Command is now npm run docs
  • Directories added to .npmignore

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants