Skip to content

Commit eeac773

Browse files
authored
doc: cleanup docs (#168)
* removed aborted project of documentation templates (superseded by organization-wide doc site on github pages) * replaced local boiler plate documentation by links to org doc site * reorganized envisioned roadmap (more of a wish list) * removed unused folder audit Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
1 parent 34872d7 commit eeac773

16 files changed

Lines changed: 53 additions & 1222 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 0 additions & 214 deletions
This file was deleted.

.github/DCO.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,27 @@ Common Continuous Integration (`CI`) workflows and setup for go-openapi repos.
1818
* shared `dependabot` configuration (**BLOCKED**)
1919
* shared `golangci-lint` configuration (**BLOCKED**)
2020

21+
<!--
2122
## Announcements
22-
23-
* **2025-12-19** : new community chat on discord
24-
* a new discord community channel is available to be notified of changes and support users
25-
* our venerable Slack channel remains open, and will be eventually discontinued on **2026-03-31**
26-
27-
You may join the discord community by clicking the invite link on the discord badge (also above). [![Discord Channel][discord-badge]][discord-url]
28-
29-
Or join our Slack channel: [![Slack Channel][slack-logo]![slack-badge]][slack-url]
23+
-->
3024

3125
## Status
3226

33-
Development is active. We are regularly adding more shared workflows to standardize CI across go-openapi repos.
27+
Active development.
28+
29+
We are regularly adding more shared workflows to standardize CI across go-openapi repos.
3430

3531
> NOTE: at this moment, it is difficult to share the configurations for dependabot and golangci-lint,
3632
> so these are not shared yet.
3733
34+
## Content
35+
36+
This repository essentially contains github action workflows in `.github/workflows`.
37+
38+
`go` code in this repo is provided only for the purpose of testing these workflows.
39+
40+
Workflows contents are detailed [here][.github/workflows/README.md].
41+
3842
## Example
3943

4044
`go-test.yml`
@@ -101,7 +105,7 @@ jobs:
101105
secrets: inherit
102106
```
103107

104-
## Available workflows `[v0.1.0]`
108+
## Available workflows `[v0.2.16]`
105109

106110
### Dependencies automation
107111

@@ -164,9 +168,9 @@ This content ships under the [SPDX-License-Identifier: Apache-2.0](./LICENSE).
164168
## Other documentation
165169

166170
* [All-time contributors](./CONTRIBUTORS.md)
167-
* [Contributing guidelines](.github/CONTRIBUTING.md)
168-
* [Maintainers documentation](docs/MAINTAINERS.md)
169-
* [Code style](docs/STYLE.md)
171+
* [Contributing guidelines][contributing-doc-site]
172+
* [Maintainers documentation][maintainers-doc-site]
173+
* [Code style][style-doc-site]
170174
* [Roadmap](docs/ROADMAP.md)
171175

172176
## Cutting a new release
@@ -215,3 +219,7 @@ Maintainers can cut a new release by either:
215219
[goversion-url]: https://github.com/go-openapi/ci-workflows/blob/master/go.mod
216220
[top-badge]: https://img.shields.io/github/languages/top/go-openapi/ci-workflows
217221
[commits-badge]: https://img.shields.io/github/commits-since/go-openapi/ci-workflows/latest
222+
<!-- Organization docs -->
223+
[contributing-doc-site]: https://go-openapi.github.io/doc-site/contributing/contributing/index.html
224+
[maintainers-doc-site]: https://go-openapi.github.io/doc-site/maintainers/index.html
225+
[style-doc-site]: https://go-openapi.github.io/doc-site/contributing/style/index.html

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This policy outlines the commitment and practices of the go-openapi maintainers
66

77
| Version | Supported |
88
| ------- | ------------------ |
9-
| 0.22.x | :white_check_mark: |
9+
| 0.2.x | :white_check_mark: |
1010

1111
## Reporting a vulnerability
1212

audit/README.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)