Git Product home page Git Product logo

guides-common's Introduction

Writing guides guidelines

In this repository you will find a variety of common files and resources for writing the guides.

The common files include:

  • LICENSE (to be placed in every guide).
  • template.adoc guide template.
  • .gitignore common gitignore file (you should copy it into your guide repository. Feel free to edit it).
  • gitclone.adoc to place near the start of each guide for instructions on how to clone the guide repository and get started.
  • finish.adoc to place at the end of each guide.
  • mvnbuild.adoc to place near the end of the guide for maven build instructions.
  • mvncompile.adoc to place in the building section of the guide for instructions on how to repackage everything without having to restart the server.
  • mvnverify.adoc to place near the end of the guide for instructions on how to run the tests.

For additional instructions including formatting, styling, etc. of the guides, visit the Wiki located in this repository.

Please pay close attention to the "Getting started" Wiki page. It contains important information that will not only help you make decisions when writing your guides but will also help keep all the guides concise and clean.

guides-common's People

Contributors

gkwan-ibm avatar kubik42 avatar ahmad-ayyoub avatar evelinec avatar junyisun avatar proubatsis avatar lauracowen avatar steven1046 avatar justineechen avatar kinueng avatar nottycode avatar yeekangc avatar andrewdes avatar swopebe avatar

Watchers

James Cloos 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.