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

Enhance Documentation for Catalogue Server: Expanded Setup and Usage Guide #389

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

Kranthi-Guribilli
Copy link
Contributor

@Kranthi-Guribilli Kranthi-Guribilli commented Oct 30, 2024

This PR introduces several important documentation updates and additions to ensure clarity, collaboration, and security in the server:

  • Code of Conduct: Establishes guidelines for respectful and inclusive interactions within the community.
  • Contribution Guidelines: Provides a clear structure for contributing, including setup instructions, coding standards, and pull request expectations.
  • Security Documentation: Outlines the process for reporting vulnerabilities and security best practices.
  • Documentation Updates: Enhances Readme.md, explanation.md, solution_architecture.md, FAQ.md, and configuration.md for improved setup guidance, architecture insights, and common troubleshooting tips.
  • These updates are intended to support a better contributor experience and improve the overall maintainability of the server.

@jenkins-datakaveri
Copy link
Collaborator

Can one of the admins verify this patch?

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

Successfully merging this pull request may close these issues.

2 participants