Coder Social home page Coder Social logo

documentation's Introduction

Documentation

CI status

CircleCI

Welcome to Los Santos

Ensure you have the following prerequisites installed:

Getting started

Clone the repository:

$ git clone https://github.com/islos-efe-eme/documentation
$ cd documentation

Yarn scripts reference

Command Description
docs:dev Local development server in localhost:8080 + auto-reload.
docs:build Production build.

New section

  1. Create a directory for your section: mkdir docs/my-section
  2. Create the entry point for your section: touch docs/my-section/README.md
  3. Add the route '/my-section/' to the array of routes in the configuration file .vuepress/config.js.
  4. The new section will be available under URL/my-section/.

Docker support

Use the provided Dockerfile to build the image and run a container.

$  docker build --rm -f "Dockerfile" -t documentation:latest "."
$  docker run --rm -d -p 8080:8080/tcp documentation:latest

Visit http://localhost:8080 on your browser.

documentation's People

Contributors

crolopez avatar jesusgn90 avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

documentation's Issues

Getting Started

Hi motherfuckers!

Like a fucking noob, I need a getting started page in your web.

You page was created for pro-players, not for noobs.

I/E Vehicles and menu refactor

Hi team,

It is necessary to add content to the documentation of this business type. Regardless, I think that it must be a subsection of a new section called SecuroServ business lines (for example), which should also include a subsection for the boxes business.

Tasks

  • Create a new section to include the SecuroServ business lines.
  • Create a subsection for I/E vehicles and fill it.

Doomsday series

Hi team,

The doomsday heists section is currently empty. It is necessary to fill it by including a subsection for each act and some generical tip.

  • The Data Breaches (ACT I).
  • The Bogdan Problem (ACT II).
  • The Doomsday Scenario (ACT III).

Minimal information: https://gta.fandom.com/wiki/Heists_in_GTA_Online

Complete repository renaming

Recently we renamed the repository, however, we still have some places with the URL hardcoded.

@crolopez reported at least these:

  • deploy.sh
  • docs/.vuepress/config.js
  • Dockerfile
  • README.md
  • package.json

Make Circle CI publish to production on master commits

Right now, the deployment to production (gh-pages) is being made by hand. We should rely on the CI system.

  • Create new Circle CI configuration
    • The CI must ensure the build is consistent before doing the deployment
    • Only master push is allowed for a deployment
    • Deployments can be done using only the right SSH key

Drug labs

Hi team,

It would be nice to improve the drug labs section.

Casino heist

Hi team,

The casino heist section only has content in the Silent and Sneaky part. It is necessary to improve the documentation of this approach and to add content to the other 2.

  • (IMPROVE) Silent and Sneaky.
  • The Big Con.
  • Aggressive.

Minimal information: https://gta.fandom.com/wiki/Heists_in_GTA_Online

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.