Synchronize general documentation

[jonaslagoni]

Reason/Context

The files CODE_OF_CONDUCT.md, CONTRIBUTING.md, FUNDING.yml, SECURITY.md, and SUPPORT.md should IMO be synchronized to the organization's repositories to provide a coherent documentation experience.

Description

As @derberg suggested on Slack there are two solutions to this.

1. Synchronzie the documents
2. Repository "owners" create their own wrappers to files such as CONTRIBUTING.md and simply reference this repository.

There are pros and cons for both solutions, so what fits best?

I assume it is somewhat related to #38

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴
It will be closed in 60 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation.
Thank you for your contributions ❤️

[derberg]

this is very much needed, people still expect CONTRIBUTING file as part of the repo as a file on the root. Habits 🤷🏼

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴
It will be closed in 60 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation.
Thank you for your contributions ❤️

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴
It will be closed in 60 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation.
Thank you for your contributions ❤️

[derberg]

I think it is going to happen pretty soon 😄 stay tuned

[Relequestual]

IMHO this requires 3 things to be useful.

1. Comment in the document (markdown comment) which says that the doc is managed at another location (providing that location link)
2. Configurable as to which of the documents are synced
3. Configurable as to which repos the sync will go to

[derberg]

@Relequestual

1 - yup, we do it with the workflow files already. Just that instead of markdown comment it should be HTML comment that is visible only in a source file IMHO
2 - yup, this is how will it work, you basically provide a list of files
3 - yes yes yes, or no 😄 I was thinking about it, like a "topic" that you set on a repo to say you shall not pass, but on the other things, I was thinking about an approach that actually the contribution guide anyway must be as generic as possible, and should be copied everywhere and then per repo you just need to have "contribution guide extensions", like additional files, repo specific 🤔

[Relequestual]

you just need to have "contribution guide extensions", like additional files, repo specific 🤔

You could broaden this. Use configs in repos to find MD or HTML partials which are inserted, and you've got yourself a templating system.

But, I would suggest this feature doesn't prohibit the others being released.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️