Howdy!

This is IMHO very useful but it would be much more useful if there were

some explicit links to this older manual pages. Is it possible to add those links to the main /docs/ page?

To clarify, you want a link to the old docs as well, on the page https://www.gimp.org/docs ?

Would something like

* English (2.8)

work, (where there is a link for "2.8" to the old versions)?

2) is it possible to add also a /docs/devel/ link or something like that to the /docs/ page to enable users to consult also the (on going) development pages? That would come very useful to enable the review of the documents by some other people - people like voluteers willing to help the revision of the translations or of the reference docs.

Where should the /docs/devel/ link go to, exactly? Where are the on-going development pages located (url)?

https://patdavid.net
GPG: 66D1 7CA6 8088 4874 946D  18BD 67C7 6219 89E9 57AC

On Tue, Sep 11, 2018 at 03:29:15PM -0500, Pat David wrote:

Howdy!

This is IMHO very useful but it would be much more useful if there were

some explicit links to this older manual pages. Is it possible to add those links to the main /docs/ page?

To clarify, you want a link to the old docs as well, on the page https://www.gimp.org/docs ?

Yeah I think it could be useful ... I can try to propose a patch to the gimp-web repo but I am not a very good boot web designer... but I can try...

Would something like

* English (2.8)

work, (where there is a link for "2.8" to the old versions)?

precisely

Look at this (old) page for an example:

https://docs.gimp.org/download.html

(see that there are even the older docs, 2.6 or even 2.4 for example). Kept for historical reasons?

2) is it possible to add also a /docs/devel/ link or something like that to the /docs/ page to enable users to consult also the (on going) development pages? That would come very useful to enable the review of the documents by some other people - people like voluteers willing to help the revision of the translations or of the reference docs.

Where should the /docs/devel/ link go to, exactly? Where are the on-going development pages located (url)?

This is the problem. I was not able to figure out the URL (if there is any).

If there was an open dir like it is for this project (KiCad) for instance:

http://docs.kicad-pcb.org/

it would be much easier to search through the docs version without the need to update the web page at every new version...

if you try with gimp you get this old page:

https://docs.gimp.org/

So first and foremost we should ask a web developer where it is. If there is none, I would ask gently the developers to create one with an CI server connected just to render the on-going documentation and translation efforts continuously. Is it asking too much? Hope not! :-)

--
https://patdavid.net
GPG: 66D1 7CA6 8088 4874 946D 18BD 67C7 6219 89E9 57AC

Marco Ciampa

I know a joke about UDP, but you might not get it.

------------------------

 GNU/Linux User #78271
 FSFE fellow #364

------------------------

Would something like

* English (2.8)

work, (where there is a link for "2.8" to the old versions)?

precisely

Look at this (old) page for an example:

https://docs.gimp.org/download.html

(see that there are even the older docs, 2.6 or even 2.4 for example). Kept for historical reasons?

Actually, since we have that page I think it might be best to include a link at the end of the list of current version docs. Perhaps something like:

"The user manual for previous versions of GIMP can be found here "

I can add this shortly.

So first and foremost we should ask a web developer where it is. If there is none, I would ask gently the developers to create one with an CI server connected just to render the on-going documentation and translation efforts continuously. Is it asking too much? Hope not! :-)

This one is a little different. The "docs.gimp.org" sub-domain is separate from the main www.gimp.org domain, and I haven't had a chance to really familiarize myself with it enough. I'm certainly happy to get something set up for CI/publish of the current docs (but I am also a bit ignorant of how the docs are managed overall...).

I'll ask about getting something setup.

https://patdavid.net
GPG: 66D1 7CA6 8088 4874 946D  18BD 67C7 6219 89E9 57AC

On Wed, Sep 12, 2018 at 9:48 AM Pat David via gimp-docs-list < gimp-docs-list@gnome.org> wrote:

This one is a little different. The "docs.gimp.org" sub-domain is separate from the main www.gimp.org domain, and I haven't had a chance to really familiarize myself with it enough. I'm certainly happy to get something set up for CI/publish of the current docs (but I am also a bit ignorant of how the docs are managed overall...).

Regarding this point specifically. Jenkins is capable of publishing HTML reports of the latest documentation. I would just have to know how the current documentation is generated (shell script maybe?), and which branch is the latest "devel". From there, we can orchestrate Jenkins pipelines that trigger on every commit to master to generate the latest development documentation and host it.

Jenkins can host the devel documentation. The GIMP docs page would simply need to link to the devel docs hosted at Jenkins.

Please create an issue at https://gitlab.gnome.org/World/gimp-ci/jenkins-dsl/issues and answer the following questions:

* Where is the source code repository for the documentation in question? (link to repo)
* How does HTML get generated from the repository? (what are the commands; what dependencies are required)
* Where do I find the documentation after it is generated? (the path in the build tree of the final HTML result)

With that information I can develop a pipeline for you to create these development docs.

Awesome, thank you Sam!

This might be something that would be good for me to learn and help with administering. I'm not sure how the docs currently get built, but I'll check into it more and hopefully get an answer to you (assuming someone smarter than I doesn't do it first).

pat

On Wed, Sep 12, 2018 at 6:15 PM Sam Gleske wrote:

On Wed, Sep 12, 2018 at 9:48 AM Pat David via gimp-docs-list < gimp-docs-list@gnome.org> wrote:

This one is a little different. The "docs.gimp.org" sub-domain is separate from the main www.gimp.org domain, and I haven't had a chance to really familiarize myself with it enough. I'm certainly happy to get something set up for CI/publish of the current docs (but I am also a bit ignorant of how the docs are managed overall...).

Regarding this point specifically. Jenkins is capable of publishing HTML reports of the latest documentation. I would just have to know how the current documentation is generated (shell script maybe?), and which branch is the latest "devel". From there, we can orchestrate Jenkins pipelines that trigger on every commit to master to generate the latest development documentation and host it.

Jenkins can host the devel documentation. The GIMP docs page would simply need to link to the devel docs hosted at Jenkins.

Please create an issue at https://gitlab.gnome.org/World/gimp-ci/jenkins-dsl/issues and answer the following questions:

* Where is the source code repository for the documentation in question? (link to repo)
* How does HTML get generated from the repository? (what are the commands; what dependencies are required)
* Where do I find the documentation after it is generated? (the path in the build tree of the final HTML result)

With that information I can develop a pipeline for you to create these development docs.

https://patdavid.net
GPG: 66D1 7CA6 8088 4874 946D  18BD 67C7 6219 89E9 57AC

Sounds good, thanks! I tried to document everything well in the README and documentation for how to contribute. I'd be curious how well you do trying to contribute using that documentation. It would be a chance to improve the GIMP CI contributor docs for people who are not me :D

On Wed, Sep 12, 2018 at 4:18 PM Pat David wrote:

Awesome, thank you Sam!

This might be something that would be good for me to learn and help with administering. I'm not sure how the docs currently get built, but I'll check into it more and hopefully get an answer to you (assuming someone smarter than I doesn't do it first).

pat

On Wed, Sep 12, 2018 at 6:15 PM Sam Gleske wrote:

On Wed, Sep 12, 2018 at 9:48 AM Pat David via gimp-docs-list < gimp-docs-list@gnome.org> wrote:

This one is a little different. The "docs.gimp.org" sub-domain is separate from the main www.gimp.org domain, and I haven't had a chance to really familiarize myself with it enough. I'm certainly happy to get something set up for CI/publish of the current docs (but I am also a bit ignorant of how the docs are managed overall...).

Regarding this point specifically. Jenkins is capable of publishing HTML reports of the latest documentation. I would just have to know how the current documentation is generated (shell script maybe?), and which branch is the latest "devel". From there, we can orchestrate Jenkins pipelines that trigger on every commit to master to generate the latest development documentation and host it.

Jenkins can host the devel documentation. The GIMP docs page would simply need to link to the devel docs hosted at Jenkins.

Please create an issue at https://gitlab.gnome.org/World/gimp-ci/jenkins-dsl/issues and answer the following questions:

* Where is the source code repository for the documentation in question? (link to repo)
* How does HTML get generated from the repository? (what are the commands; what dependencies are required) * Where do I find the documentation after it is generated? (the path in the build tree of the final HTML result)

With that information I can develop a pipeline for you to create these development docs.

--
https://patdavid.net
GPG: 66D1 7CA6 8088 4874 946D 18BD 67C7 6219 89E9 57AC