Documentation generation for 6.6.x

[Sébastien BEAUDLOT]

Hi,

I need information from documentation of version 6.6, but it is already offline.

It may be possible to regenerate documentation from github codebase, but i can"t manage to do it.

Can anyone give me a hint on how to generate documentation from the code ?

Regards.

PS: archive.org is not helping because of the menus and tabs.

[Y G]

Hello,

I second that what Sébastien has written, i tried to replicate the steps by reading and trying as the github action ( and sh file under ci), but needing ruby, generating right version documentation was such a hassle and i could not made it work. Any easier solution / explanation is much appreciated.

Thank you.

18 Eylül 2024 Çarşamba tarihinde saat 17:26:12 UTC+3 itibarıyla Sébastien BEAUDLOT şunları yazdı:

[Ray Bon]

Sébastien,

There may be a gradle task, https://apereo.github.io/cas/developer/Build-Process.html#tasks

Ray

On Wed, 2024-09-18 at 07:13 -0700, Sébastien BEAUDLOT wrote:

You don't often get email from sebastien...@univ-avignon.fr. Learn why this is important

[Y G]

Hello again,

I found this: https://github.com/apereo/cas/blob/gh-pages/README.md

trying now, could you also check if this works?

Requirements

Install the build dependencies and tools via: https://help.github.com/articles/using-jekyll-with-pages/.

Getting Started

1. git clone g...@github.com:Jasig/cas.git cas.site
2. git checkout gh-pages
3. Change documentation as necessary
4. git push --set-upstream origin gh-pages

Local Site Generation

./build[sh|bat]

To view the site locally:

bundle exec jekyll serve

Navigate to http://localhost:4000 to see the local site.

18 Eylül 2024 Çarşamba tarihinde saat 21:12:08 UTC+3 itibarıyla Ray Bon şunları yazdı:

[Y G]

New update:

I extracted related 6.6.x documentation from gh-pages branch and served it on my domain for the time being. Files needs to be on /cas directory to work without issue.

Extracted Docs: https://github.com/Kambaa/cas-6.6.x-documentation

Link: https://yusufgunduz.tr/cas

18 Eylül 2024 Çarşamba tarihinde saat 21:12:08 UTC+3 itibarıyla Ray Bon şunları yazdı:

Sébastien,

[Sebastien BEAUDLOT]

Thank you Yusuf, i am now able to generate documentation !

---

De: "Y G" <yusuf....@gmail.com>
À: "CAS Community" <cas-...@apereo.org>
Cc: "Ray Bon" <rb...@uvic.ca>
Envoyé: Mercredi 18 Septembre 2024 21:06:45
Objet: Re: [cas-user] Documentation generation for 6.6.x

--
- Website: https://apereo.github.io/cas
- List Guidelines: https://goo.gl/1VRrw7
- Contributions: https://goo.gl/mh7qDG
---
You received this message because you are subscribed to the Google Groups "CAS Community" group.
To unsubscribe from this group and stop receiving emails from it, send an email to cas-user+u...@apereo.org.
To view this discussion on the web visit https://groups.google.com/a/apereo.org/d/msgid/cas-user/4ad6d99c-38de-4e39-a50c-74dfe28cf103n%40apereo.org.

[Kostas Kalevras]

How did you create the documentation? It is not just sufficient to download the relevant folders from the gh-pages repo branch.

For anyone wanting to access the docs locally here's a simple 5 line Dockerfile:

# syntax=docker/dockerfile:1
FROM httpd:2.4
ARG REPO="https://github.com/Kambaa/cas-6.6.x-documentation.git"

ADD ${REPO}#:/cas /usr/local/apache2/htdocs/cas

build: docker build -t cas-docs .

run: docker run --rm -d -p 80:80 --name cas-docs cas-docs

[Jorge Bastida]

Is available again => https://apereo.github.io/cas/6.6.x/

[Y G]

I installed ruby and tried the build.sh file on the gh-pages branch as written in readme, but there was some errors that i did not want to investigate(something about not finding a Hazelcast...md file inside somewhere), so i tried to extract the html files manually.

In a folder named cas, i put these folders and files(from https://github.com/apereo/cas/tree/gh-pages ) :

- 6.6.x folder that contains the necessary version's docs

- stylesheets, javascripts and images folder on the main branch is needed for the web pages

- I added index.html on the main branch and edited the redirection code to 6.6.x folder

- I copied the stylesheet.css from the Apereo CAS website (scss version is on the branch, needed processed version)

- then checked pages for any non-working js codes.

Not a good way but good enough for a time in need.

Have a nice day.

19 Eylül 2024 Perşembe tarihinde saat 12:50:08 UTC+3 itibarıyla Kostas Kalevras şunları yazdı:

[Kostas Kalevras]

Thanks a lot

Created a simple repo for a Docker image pulling documentation directly from the gh-pages branch of apereo CAS repo. Supports different versions as a build argument.

https://github.com/kkalev/simple-cas-docs

Tested with version 6.6.x. Any bugs are my own.