Skip to content
This repository was archived by the owner on Apr 13, 2020. It is now read-only.

Conversation

@dennisseah
Copy link
Collaborator

@dennisseah dennisseah commented Feb 19, 2020

related to microsoft/bedrock#976
under docs/commands, we have
data.json - contains information of all commands
spk.js - fetch data.json and render the commands accordingly.

in package.json, we added a command, build-cmd-docs. so we can call it once we release a new SPK version, yarn build-cmd-docs. This command creates docs/commands/data.json. Implementation of this command is in tools/generateDoc.ts

@andrebriggs, please enable github pages once this PR is merged. and the url to this page should be
https://catalystcode.github.io/spk/commands/index.html
it should look like this https://dennisseah.github.io/simple/commands/index.html

I only have the md file for spk init. The rest of the team members have to chime in to create the rest of the md files. Or I can get them from guides folder

@andrebriggs
Copy link
Collaborator

@dennisseah we should update the release instructions to include instructions about running build-cmd-docs. I believe this should probably be the step before PR in the bump version section. Alternatively we can add the call to the end of the ./scripts/release-version-bump file to reduce manual steps.

@dennisseah
Copy link
Collaborator Author

@dennisseah we should update the release instructions to include instructions about running build-cmd-docs. I believe this should probably be the step before PR in the bump version section. Alternatively we can add the call to the end of the ./scripts/release-version-bump file to reduce manual steps.

@andrebriggs, I have chosen to update release-version-bump file. Hope that it is ok with you. and I have add guides/command-implementation.mdon what developer needs to do when implementing command(s)

Copy link
Collaborator

@andrebriggs andrebriggs left a comment

Choose a reason for hiding this comment

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

LGTM

@dennisseah dennisseah merged commit 0579b42 into master Feb 19, 2020
@dennisseah dennisseah deleted the ds-tools branch February 19, 2020 20:23
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants