Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation on how to generate documentation on the local machine #3205

Merged
merged 1 commit into from
Dec 19, 2024
+21 −0
Merged

Add documentation on how to generate documentation on the local machine #3205

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,27 @@ In CloudFoundry terms
* `app` is a webapp that needs single sign on and access to the `api`
service on behalf of users.

## Generating API Documentation

API documentation is generated using the [`spring-restdocs`](https://github.com/spring-projects/spring-restdocs) framework.
The tests that run this are located in [`uaa/tests`](file:./uaa/src/test/java) folder and are very similar to MockMvc tests.

The formatting of the output documentation is done by using Ruby and [Slate](https://github.com/slatedocs/slate).

To be able to run the command `./gradlew generateDocs` having Ruby 3.3.5 and bundler installed is key.

### Installing Ruby using brew and rbenv

```shell
brew install rbenv
rbenv install 3.3.5
rbenv global 3.3.5 # or use rbenv local 3.3.5
gem install bundler
./gradlew generateDocs
```

The produced documentation can be accessed via [index.html](file:./uaa/build/docs/version/0.0.0/index.html)

# Running the UAA on Kubernetes

__Prerequisites__
Expand Down
Loading