search

nats-io / nats-architecture-and-design

Architecture and Design Docs
Apache License 2.0
177 stars 20 forks source link

create indexes to ADRs by tag #3

Closed ripienaar closed 2 years ago

ripienaar commented 2 years ago

To improve discoverability the list of ADRS is rendered in the main repo README, one index per tag.

Each ADR has some new metadata that defines tags and a few other things, these are parsed by index.go to generate the README.

A single ADR directory for all ADRs is again created

Signed-off-by: R.I.Pienaar rip@devco.net

ripienaar commented 2 years ago

Please see https://github.com/nats-io/nats-architecture-and-design/blob/d3f9bded25d8bbef62a1048937486f4b74f033c1/README.md for the final outcome.

ripienaar commented 2 years ago

This PR is a response to @scottf stating:

Please just go to the repo and set it like you want and set the naming convention / standard. 
Present an issue asking for confirmation.

So here it is, please can those on the review list chime in.

We will then remove the ADRs from the server, I'll reconcile against the server with whatever ADRs @aricart has in flight atm.

Unfortunately since this PR was made the repository got renamed and various pushes to main against repo policy was done, but we'll figure that out.

scottf commented 2 years ago

It it possible to have the go code in a sub directory to prevent any confusion that this may be a code repo

ripienaar commented 2 years ago

It it possible to have the go code in a sub directory to prevent any confusion that this may be a code repo

It's a bit of a pain, medium term we should put this content on a https://gohugo.io/ website, this will have full text search and more. Then this repo is the source code for the site - end users see the site.

Changing this stuff into a sub dir is a bit annoying with how go "works" - you'd still end up with things in top of the repo.

ripienaar commented 2 years ago

I have added an issue template for new issues that will look like this one, we can iterate on this.

https://github.com/nats-io/nats-architecture-and-design/issues/4