Skip to content

Commit 55bbff2

Browse files
authored
Reorganize documentation structure and introduce developer guide (#2786)
* Reorganize documentation structure and introduce developer guide * Reorganize documentation structure and introduce developer guide * Add developer guide link to root README * Fix image path in requirements.md
1 parent ac3bafe commit 55bbff2

12 files changed

Lines changed: 20 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,13 +260,17 @@ Most plugins should be supported out-of-the-box or maybe require some minimal ch
260260
261261
## Adding JCasC support to a plugin
262262
263-
Plugin developers wanting to support JCasC in their plugin should [check out our how-to guide](docs/PLUGINS.md).
263+
Plugin developers wanting to support JCasC in their plugin should [check out our how-to guide](docs/developer/plugins.md).
264264
265265
## Configuration-as-Code extension plugins
266266
267267
- [configuration-as-code-groovy-plugin](https://github.com/jenkinsci/configuration-as-code-groovy-plugin)\
268268
Allows specifying groovy code that should run on during configuration.
269269
270+
## Developer Documentation
271+
272+
See the [Developer Guide](docs/developer/README.md).
273+
270274
## Jenkins Enhancement Proposal
271275
272276
As configuration as code is demonstrated to be a highly requested topic in the Jenkins community, we have published

docs/CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
## Reporting plugin compatibility issues
66

7-
See [COMPATIBILITY](./COMPATIBILITY.md)
7+
See [compatibility](developer/compatibility.md)
8+
89

910
## Why should you contribute
1011

docs/developer/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Developer Documentation
2+
3+
This section contains documentation for contributors and plugin developers
4+
working on the Configuration as Code plugin.
5+
6+
## Architecture & Design
7+
8+
- [developer.md](developer.md) — Overview of the JCasC API and extension model
9+
- [implementation.md](implementation.md) — Internal configuration processing details
10+
- [plugins.md](plugins.md) — Guidance related to plugin integration
11+
- [requirements.md](requirements.md) — Conventions and requirements for plugin maintainers
12+
- [compatibility.md](compatibility.md) — Reporting and handling plugin compatibility issues
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ API, but still require plugins to respect some contract, aka "_convention over e
55
This documentation is here to explain plugin maintainers those conventions and provide guidance
66
on expected design.
77

8-
![JCasC is coming](../images/BraceYourselves.jpg)
8+
![JCasC is coming](../../images/BraceYourselves.jpg)
99

1010
## Overview
1111

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)