Git Product home page Git Product logo

documentation's Introduction

Documentation

This repository's purpose is to keep track of the knowledge around the Jenkins infrastructure project. It gathers information for the following areas:

  • "Maintenance" section contains document used to prepare service maintenances like systems upgrade.
  • "Meeting" section contains meeting notes
  • "Service" section contains service descriptions

The contribution workflow depends on either you want a "synchronous" or "asynchronous" communication.

In the case of "synchronous" communication, use hackmd.io with documents linked in the jenkins-infra channel. Once the collaboration is done, a maintainer needs to push the document into this repository. Feel free to request access to the jenkins-infra team on hackmd.io. Our goals is to only avoid spammers.

In the case of "asynchronous" communication, open a GitHub Pull Request to ask for a review from maintainers to provide feedback, share knowledge and benefit from the Github notifications system.

There are cases where documentation lies somewhere else like the private repository jenkins-infra/runbook. In such cases, it's better to provide a link from jenkins-infra/documentation, referencing thirds document elsewhere as jenkins-infra/runbook. The purpose is to use jenkins-infra/documentation as the central source of knowledge but to keep the ability to have information where it belongs.

Contributing

They are different ways to contribute to this repository.

Request specific documentation

Whatever your motivation is, either specific information needs or just curiosity, feel free to request content documentation, smaller the request is the easier documenting it will be. To request specific documentation, you can open a Jira issue on the 'INFRA' project using the component name "documentation" and then assign it to the right person.

Links

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.