Giter Club home page Giter Club logo

docdev's Introduction

GLPI's developer documentation

Build Status

Current documentation is built on top of Sphinx documentation generator. It is released under the terms of the Creative Commons BY-NC-ND 4.0 International License.

We're following GitFlow:

  • master branch for the current major stable release,
  • develop branch for next major release.

View it online!

GLPI installation documentation is currently visible on ReadTheDocs.

Run it!

You'll just have to install Python Sphinx, it is generally available in distributions repositories for Linux.

If your distribution does not provide it, you could use a virtualenv:

$ virtualenv /path/to/virtualenv/files
$ /path/to/virtualenv/bin/activate
$ pip install sphinx

Once all has been successfully installed, just run the following to build the documentation:

$ make html

Results will be available in the build/html directory :)

Note that it actually uses the default theme, which differs locally and on readthedocs system.

Autobuild

Autobuild automatically rebuild and refresh the current page on edit. To use it, you need the sphinx-autobuild module:

$ pip install sphinx-autobuild

You can then use the livehtml command:

$ make livehtml

Creative Commons License

docdev's People

Contributors

adrienclairembault avatar al-alec avatar anaelmobilia avatar btry avatar cconard96 avatar cedric-anne avatar chpego avatar ddurieux avatar filipemenezes avatar flegastelois avatar kl3sk avatar nqb avatar orthagh avatar remicollet avatar thibaudbayol avatar tomolimo avatar trasher avatar tsmr avatar yllen avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docdev's Issues

Normal Form Database.

Hi dears, i want the database (DER) for the glpi, latest. I don't find that in web. I can't build a reverse engineering, in mysqlworkbranch, because the number of the tables is more than 360.

There are the DER to projet?

Coding Standards (proposal)

I was reading documentation about coding standards (http://glpi-developer-documentation.readthedocs.io/en/master/codingstandards.html), but some of your standards aren't following some of the PSR (http://www.php-fig.org/) which are used by a lot of open source projects.

The idea of this issue is to discuss about change the standards or at least start applying PSR-1 and PSR-2 to this project, all this in benefit of let know all developers and community about this standards used by many open source projects and frameworks, make this project another reference of good practices and follower of standards and maybe you can contribute to other PSR draft.

You can use the PHP-CS-Fixer tool (https://github.com/FriendsOfPHP/PHP-CS-Fixer) to apply those standards with out a problem and add it to a Text Editor, IDE, Git hook or C.I. to fix all code committed

Doc (plugin) not clear enough

I read about 50 times the documentation to create a plugin, but I can't achieve to do what I want.

Even if my PR are not merged on Read the docs, I don't understand what to do after this section.
It says, do a CRUD with you object. Fine, but how to access it after.

I think the doc should be re-read/re-written (I talk about the plugin part).

If some one can help me, I sent it to the forum, but no one answers, maybe here.

Thanks

A word about CS

Following glpi-priject/glpi#1100, we should add a bit on documentation on that.

Document main objects

Explain how main objects works (CommGLPI, CommonDBTM, CommonDbRelation and so on)

Github / Rebase

Hello,

I just read the updates of dev doc : great job !
I suggest to add a § on source code management : how to rebase a github fork to keep up to date with the master one.

I usually made inversed pull requests too my repository, but this isn't clean...

If some one could write doc about this, I think it can help some developpers too :)

Regards

DBmysqlIterator

GLPI v.9.1.6
I think count of DBmysqlIterator return wrong number (see attachement)
glpi_dbmysqliterator

[discussion ] CS / SQL

Proposal, change "Database queries" to:

Direct call to $DB->query() should be avoid.

To add / update / delete rows, use the appropriate CommonDBTM methods.

To select data from the DB, use the $DB->request method()

When direct SQL cannot be avoid

... previous content...

Document how to add migration in the core

When adding a new migration, there are several files to change; and there are various cases to keep in mind (such as using or not the -dev in version).

Since this is quite complex to understand each time we add a new migration script; adding some documentation would be interesting.

Variables types

On variables types, we suggest to use object for object type.

Reading the phpdoc doc, I found that

object, the element to which this type applies is the instance of an undetermined class.

We should use type "object" when the element isn't undetermined.
Else, we should use the object class name .

This will help to have a more accurate GLPI documentation ;-)

I can made a PR for this if required.
Regards

Document hooks

There are many available hooks... They should be listed and (briefly at least) documented.

Document rules

Not sure for this one, maybe it's more userdoc related; even if we could drop a line on how to implement that.

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.