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

Misc clarifications for CONTRIBUTING.md #2401

Merged
merged 3 commits into from
Sep 11, 2024
Merged

Conversation

trial-danswer
Copy link
Collaborator

Description

Catch-all PR for improving CONTRIBUTING.md documentation. Each commit is a self-contained group of related edits. Cherry-pick commits if desired.

How Has This Been Tested?

Documentation change

Accepted Risk

Documentation staleness

Related Issue(s)

?

Checklist:

  • All of the automated tests pass
  • All PR comments are addressed and marked resolved
  • If there are migrations, they have been rebased to latest main
  • If there are new dependencies, they are added to the requirements
  • If there are new environment variables, they are added to all of the deployment methods
  • If there are new APIs that don't require auth, they are added to PUBLIC_ENDPOINT_SPECS
  • Docker images build and basic functionalities work
  • Author has done a final read through of the PR right before merge

Copy link

vercel bot commented Sep 11, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
internal-search ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 11, 2024 6:43pm

Copy link
Contributor

@hagen-danswer hagen-danswer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

@hagen-danswer hagen-danswer added this pull request to the merge queue Sep 11, 2024
Merged via the queue into main with commit eab55bd Sep 11, 2024
7 checks passed
@hagen-danswer hagen-danswer deleted the docs/contributing branch September 11, 2024 21:14
rajivml pushed a commit to UiPath/danswer that referenced this pull request Oct 2, 2024
* Reorder and clarify dependency installation instructions

* Clarify instructions for local development with Docker external deps vs full Docker stack

* Final words at the end of the local setup process

---------

Co-authored-by: danswer-trial <danswer-trial@danswer-trials-MacBook-Pro.local>
rajivml pushed a commit to UiPath/danswer that referenced this pull request Oct 2, 2024
* Reorder and clarify dependency installation instructions

* Clarify instructions for local development with Docker external deps vs full Docker stack

* Final words at the end of the local setup process

---------

Co-authored-by: danswer-trial <danswer-trial@danswer-trials-MacBook-Pro.local>
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