Authentication example wrong in docs
Created by: gingeneer
The docs/User_guide.md lists
POST /sessions?user=mynethzormail&password=mypassword
as an example for authentication, which does not work as far as I know.
To receive notifications about scheduled maintenance, please subscribe to the mailing-list gitlab-operations@sympa.ethz.ch. You can subscribe to the mailing-list at https://sympa.ethz.ch
Created by: gingeneer
The docs/User_guide.md lists
POST /sessions?user=mynethzormail&password=mypassword
as an example for authentication, which does not work as far as I know.
added 1 deleted label
Created by: hermannsblum
this is I guess just one example of the many outdated descriptions in our docs
Created by: hermannsblum
This can be done more interactively following #145 This way we can also make sure that the example stays consistent with the code
Created by: hermannsblum
There is actually a code example now given for exactly this problem in #145.
The issue remains how we want to structure all our documentation. Which one goes into /docs
?
Created by: NotSpecial
I will take a look at this.
The way I see it all reasoning for code should be right in the code. The only thing one needs would be a pointer in the README on where to start reading. Especially the outdated developer docs would be obsolete then.
The user guide can maybe changed into a tutorial, but I guess useful examples on /docs would be even better than that since a REST API is not that complicated ^^
assigned to @jzumthurm
mentioned in merge request !313 (closed)
closed