DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:gitlabproject

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
plugin:gitlabproject [2017-05-31 14:18] – created Algorythmplugin:gitlabproject [2023-05-02 13:58] (current) Aleksandr
Line 2: Line 2:
  
 ---- plugin ---- ---- plugin ----
-description: Gitlab-Project display a Gitlab project inside Dokuwiki. +description: Gitlab-Project display a Gitlab project inside DokuWiki 
-author     : Algorythm  +author     : Algorythm 
-email      : m.estrada@alpi.fr +email      : ttamalfor@gmail.com
 type       : syntax type       : syntax
-lastupdate : 2017-05-31+lastupdate : 2017-10-17
 compatible : Frusterick Manners, Elenor of Tsort, Detritus, Hrun compatible : Frusterick Manners, Elenor of Tsort, Detritus, Hrun
 depends    :  depends    : 
 conflicts  conflicts 
 similar    :  similar    : 
-tags       : git, gitlab+tags       : git, gitlab, code, projects
  
 downloadurl: https://github.com/algorys/gitlabproject/archive/master.zip downloadurl: https://github.com/algorys/gitlabproject/archive/master.zip
-bugtracker : https://github.com/algorys/gitlabproject//issues+bugtracker : https://github.com/algorys/gitlabproject/issues
 sourcerepo : https://github.com/algorys/gitlabproject/ sourcerepo : https://github.com/algorys/gitlabproject/
 donationurl:  donationurl: 
Line 23: Line 23:
 ===== Installation ===== ===== Installation =====
  
-Download Gitlab Project into your ${dokuwiki_root}/lib/plugins folder and restart dokuwiki or use the Extension Manager.+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
  
 ===== Syntax ===== ===== Syntax =====
  
-====Default Syntax:====+==== Default Syntax ====
  
 <code php> <code php>
Line 33: Line 33:
 </code> </code>
  
-''NAMESPACE'' is the namespace of your project, typically the name of the user or group in which the project is located.+  * ''NAMESPACE'' is the namespace of your project, typically the name of the user or group in which the project is located
 +  * ''PROJECT_NAME'' is the name of project.
  
-''PROJECT_NAME'' is the name of project. +For e.g., if you have a project available at ''%%http://my-gitlab/foo/bar%%'', the syntax will be:
- +
-For e.g., if you have a project available at http://my-gitlab/foo/bar, the syntax will be:+
  
 <code php> <code php>
Line 43: Line 42:
 </code> </code>
  
-====Override Server and Token====+==== Override Server and Token ====
  
-Inside the root of the plugin, you will have a JSON file called: server.json. Inside you can add other serversi and their tokens, than the one defined in the plugin settings.+Inside the root of the plugin, you will have a JSON file called: server.json. Inside you can add other servers and their tokens, than the one defined in the plugin settings.
  
 Just call it after by its name. Just call it after by its name.
Line 66: Line 65:
 </code> </code>
  
-Then simply add server parameter:+Thensimply add the server parameter with the name you've defined:
  
 <code php> <code php>
-<gitlab server="second" project="fooz/baz" />+<gitlab server="second" project="foo/bar" />
 </code> </code>
 +
 +==== Wrong project or server ====
 +
 +If project or server is not available or does not exist, gitlabproject will display a message to warn the user. 
  
 ===== Configuration and Settings ===== ===== Configuration and Settings =====
Line 77: Line 80:
  
   * **server.default**: Set your default Gitlab url, without slash ending. You can override this setting in server.json file.   * **server.default**: Set your default Gitlab url, without slash ending. You can override this setting in server.json file.
-  * **token.default**: Fill your admin token. You can ovveride this setting in server.json file.+  * **token.default**: Fill your admin token. You can override this setting in server.json file
 +  * **unwanted.users**: If you want plugin ignore some members of your projects, add them here, separated by commas.
  
 Gitlab-Project will use these data as default. Gitlab-Project will use these data as default.
Line 89: Line 93:
 Please report your issue or your idea at [[https://github.com/algorys/gitlabproject/issues|Gitlab-Project]]. Please report your issue or your idea at [[https://github.com/algorys/gitlabproject/issues|Gitlab-Project]].
  
 +Please change V3 to V4 in ''gitlab.php'' this is the ERROR
  
 +   {"error":"API V3 is no longer supported. Use API V4 instead."
 +Thanks.
plugin/gitlabproject.1496233106.txt.gz · Last modified: 2017-05-31 14:18 by Algorythm

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki