- Documentation(ReDoc): https://api-reference.smartling.com/
- Look full spec:
- Preview spec version for branch
<branch>: https://api-reference.smartling.com/preview/ (Note: use lower case name in the url for the branch)
Warning: All above links are updated only after Jenkins finishes deployment
- Install Node JS
- Clone repo and
cd- Run
npm install
- Run
- If you make changes for TQC endpoint description run
npm run process-yaml - Run
npm start - Checkout console output to see where local server is started. You can use all links (except
preview) by replacing https://smartling.github.io/api-docs/ with url from the message:Server started <url> - Make changes using your favorite editor or
swagger-editor(look for URL in console output) - All changes are immediately propagated to your local server, moreover all documentation pages will be automagically refreshed in a browser after each change
TIP: you can open
swagger-editor, and documentation in parallel - Once you finish with the changes you can run tests using:
npm test - Share your changes with the rest of the world by pushing to GitHub 😄
Our current build procedure doesn't clean up old review files for the previous branches and pull requests. As the result we may have dozens or hundreds of preview folders for those obsolete branches.
Here is the sequence of instructions to clean up all previews.
-
Switch for
gh-pagesgit branch with all published content.git checkout gh-pages -
Delete all previews.
rm -rf ./preview/* -
Commit the changes
git commit -am "Clean up contents of branch and pull requests previews" -
Push the changes
git push
NOTE: these commands will delete all preview branches and pull requests. If some of the reviews are still needed then one has to manually rerun build for those branches/PRs.