Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[📑 Docs]: Deduplicate content and replace it with reusable fragments #3261

Closed
1 task done
bandantonio opened this issue Sep 28, 2024 · 1 comment · Fixed by #3269
Closed
1 task done

[📑 Docs]: Deduplicate content and replace it with reusable fragments #3261

bandantonio opened this issue Sep 28, 2024 · 1 comment · Fixed by #3269

Comments

@bandantonio
Copy link
Contributor

bandantonio commented Sep 28, 2024

What Dev Docs changes are you proposing?

There are at least 15 files across documentation that have duplicated content related to contribution guidelines and asking questions.
I strongly believe that these content chunks should be added to Markdown files as reusable components to leverage the DRY and single source of truth principles. This is a way to avoid falling into anti-patterns like the solutions provided for the issue #3176

15 files: documentation contributor question

1

15 files (24 occurrences): Tag me in your AsyncAPI Doc PRs

2

6 files: Docs contributor questions

3

15 files: To get started as a Docs contributor

4

Note

I believe that documentation contains even more duplicated fragments that I mentioned above, so a preliminary audit of pages is highly recommended.

Note

I will take care of this issue

Code of Conduct

  • I agree to follow this project's Code of Conduct
@ishwarthecodddr
Copy link

could you explain more with a example .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants