You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-1Lines changed: 25 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,20 @@ This is the repo containing the kroxylicious.io website.
6
6
The site runs on Jekyll, so you'll need to ensure you have the [prerequisites](https://jekyllrb.com/docs/) installed to try it locally.
7
7
You'll also need to ensure you have Ruby 3.2+ installed, along with the latest versions of Rake and Bundler for your Ruby distribution.
8
8
9
+
<!-- TOC -->
10
+
*[Kroxylicous.io Site](#kroxylicousio-site)
11
+
*[What?](#what)
12
+
*[Key Files](#key-files)
13
+
*[Development](#development)
14
+
*[Running in a Container](#running-in-a-container)
15
+
*[Building Production HTML](#building-production-html)
16
+
*[Running on GitHub Pages on a Fork](#running-on-github-pages-on-a-fork)
17
+
*[Binary content](#binary-content)
18
+
*[Excalidraw images](#excalidraw-images)
19
+
*[Redirects](#redirects)
20
+
*[Contributing](#contributing)
21
+
<!-- TOC -->
22
+
9
23
## Key Files
10
24
-[Gemfile](Gemfile) - required ruby gems for building and serving the site
11
25
-[_config.yml](_config.yml) - Jekyll configuration for building the site
@@ -86,4 +100,14 @@ mappings:
86
100
fromVersion: 0.10.0 #Optional, if not specified the latest release at time of site build is used.
87
101
toVersion: 0.12.0 #Optional, if not specified the latest release at time of site build is used.
88
102
path: /html/kroxylicious-proxy/#con-configuring-client-connections-proxy # the path within the baseUrl
89
-
```
103
+
```
104
+
105
+
# Contributing
106
+
107
+
You can contribute by:
108
+
109
+
* Raising any issues you find in the [Issue tracker](https://github.com/kroxylicious/kroxylicious/issues)
110
+
* Fixing issues by opening Pull Requests
111
+
* Improving documentation (note that release-specific documentation lives in [kroxylicous/kroxylicious](https://github.com/kroxylicious/kroxylicious/tree/main/docs))
112
+
113
+
Check out our [Join Us](https://kroxylicious.io/join-us/) page for more information on contributing to the project!
0 commit comments