Giter Site home page Giter Site logo

willyk / documentation-site Goto Github PK

View Code? Open in Web Editor NEW

This project forked from travelgatex/documentation-site

0.0 0.0 0.0 44.01 MB

This repository contains source for TravelgateX documentation. TravelgateX is a collection of GraphQL APIs for the travel trade.

Home Page: https://docs.travelgatex.com

License: MIT License

Shell 0.02% HTML 19.37% CSS 17.55% JavaScript 63.06%

documentation-site's Introduction

TravelgateX Documentation

This repository contains source for TravelgateX documentation. TravelgateX is a collection of GraphQL APIs for the travel trade.

Master branch is published to https://docs.travelgatex.com

Contributing

  1. Fork and clone the repository
  2. Create a new branch: git checkout -b feature/my-new-feature-name
  3. Make your change
  4. Push to your fork and submit a pull request
  5. Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.
  • In your pull request description, provide as much detail as possible. This context helps the reviewer to understand the motivation for and impact of the change.

Report an issue

Installing

  • Install Hugo
  • Clone the repo:

git clone [email protected]:travelgateX/documentation-site.git

  • Go into the repository folder

cd documentation-site

  • Init the submodule

git submodule update --init

  • Edit the markdown files in the content directory
  • Start the local webserver:

hugo server -D

  • View your changes locally at http://localhost:1313/

Deployment

The website is hosted in Github Pages. Hugo generates the static HTML files and in order to deploy we need push the changes to the travelgatex.github.io repository.

There's a script that does this automatically:

./deploy.sh

Common Pitfalls

Cannot push submodule

Sometimes we cannot push the submodule to github. In order to fix this issue you need to change to the public directory and overwrite the local changes with the uptream version:

cd public/
git reset --hard origin/master
git pull origin master
cd ..
./deploy.sh

Submodule not in master branch

Sometimes the submodule stats checkout in a specific commit. In order to fix it, just change to that directory and checkout master

cd public/
git checkout master
git reset --hard origin/master
git pull origin master
cd ..
./deploy.sh

Build documentation reference

cd script
npm install
npm start
cd ..

documentation-site's People

Contributors

abasalo avatar ajarilloxtg avatar alexjmoya avatar arquio avatar catarinaav avatar ccanellas avatar ddelcastillo245 avatar dmerida avatar fjortizescuchas avatar globix avatar gtorrens avatar jmateutgx avatar luisacamara avatar mgboydcom avatar mikimartin88 avatar mmorenopons avatar mvermeulenx avatar noelmaya avatar patricia-insights avatar pbarea avatar pedrobc avatar pperaltaisern avatar rubencaballero avatar slucea avatar srnemuri avatar vfont7 avatar zbatik-xtg avatar zechao 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.