Git Product home page Git Product logo

docs-tools's Introduction

Speedyrails ZenDesk Publishing Scripts

What is this toolset, and why does it exist?

ZenDesk does not include version control in its help center. To fix this, we've created a tool to locally create markdown files for our help center and maintain version control for documentation as our product changes and evolves. Doing so maintains data integrity and will ultimately add to the IX goals of the company.

What does it do?

  1. Lists current sections in a help center
  2. Publishes markdown files to a help center via API (using github/markup)

Important Notes

docscli.rb uses API token authentication. Make sure that your credentials point to /token sandbox.rb uses basic User/Password authentication.

Both scripts require the full path to the file. To get a full path, navigate to the file directory in your terminal and type pwd.

Usage

List sections in a help center

ruby sandbox.rb sections ruby docscli.rb sections

Publish a document to a help center

ruby sandbox.rb publish --file=/Users/.../docs/path/to/doc.md

ruby docscli.rb publish --file=/Users/.../docs/path/to/doc.md

docs-tools's People

Contributors

mbuttler avatar

Stargazers

Oluwatobi Shokunbi  avatar Kalin Tsonchev avatar Deborah avatar Aaron Thayer avatar Roger Sheen avatar Kiera Manion-Fischer avatar David Bastedo avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.