Added new folder docs with config-options description on options. #370
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This is a good start! A few comments:
|
added 3 commits
December 17, 2020 20:43
updated formatting for config options documentation and added link in readme.
|
@salemhilal thanks for your time doing peer review , i have updated the readme and config with requested updates.Please check and let me know. |
salemhilal
reviewed
Jan 22, 2021
|
Actually, it looks like I can apply changes myself. Let me know if you're ok with them and I'll merge this branch in. |
|
@salemhilal thank you very much am okay for this to be merged. |
AlexFielder
added a commit
to AlexFielder/hound
that referenced
this pull request
Jul 28, 2021
* Update config-example.json * Add CONTRIBUTING.md file * Dockerfile should use github.com/hound-search This fixing the docker build issue. * make listen URL clickable in iTerm (hound-search#340) * Add Jest tests and Prettier support (hound-search#343) This commit adds support for Jest and writes a few simple tests as proof. Adding a test is as easy as adding a file that ends in `.test.js` next to the file you want to test. Any file that matches that pattern should have access to Jest functions. The whole test suite can be run with `npm run test`. I also added support for Prettier. Running `npm run format` should run Prettier on any staged changes. I thought about adding Husky to automatically run Prettier as a pre-commit hook, but it seems as though Husky requires git v2.13 which would require me upgrading Git. I didn't add support for ESLint yet since I figured that may be a slightly more involved conversation — Prettier seems to be generally uncontroverical and is generally only slightly configurable, whereas ESlint is highly configurable and behaves however we want it to. * Git VCS driver: Support non-default target refs (hound-search#345) Currently, only the default ref (`master`) is supported. - Allow target non-default target refs to be specified via configs. - Add config-driven target ref auto-detection using the `HEAD` branch. - Update default repo base URL pattern to link to the content revision, accounting for potential non-default target ref usage. - Add global-level VCS configs which are merged into the repo-level configs during startup (repo-level vals take precedence). * Exclude file path (hound-search#347) * index: add a search option to exclude files given a regexp * api: add the excludeFiles query parameter Set the index search options ExcludeFileRegexp with this parameter to allow excluding files from the search via a regexp. * js: add the excludeFiles search parameter * css: increase the label width to fit 'Exclude file path' * js: correctly check that advanced is empty * Update README with contact info for maintainers. (hound-search#348) I don't think there's a clear way to see who has push privs to this repo from the public, and even if there is, the "Get In Touch" section should probably list the maintainers. * incorporate detailing around gopath in README's quick start instructions (hound-search#352) Co-authored-by: Rebecca Lau <[email protected]> * pin alpine version to make the docker pass * Update Dockerfile * More detailed setup documents with less assumptions on users (hound-search#359) This commit updates the readme to be a little more verbose for people who don't necessarily have Go or Docker set up, but who want to contribute nonetheless. * Apply the old patch * add some figures * remove the idea code * get it untitled * remove * add .idea dev tools * remove simple config * get config back * detailing tests and simplifying the setup * Commit TLS support guide Co-authored-by: Salem <[email protected]> * make the statement terser * delete unused img * rewording * back to the old path * Update README.md * Update README.md * Update README.md * Update README.md Co-authored-by: Salem <[email protected]> * Initialize Go Modules `go mod init github.com/hound-search/hound` * Replace jteeuwen/go-bindata with go-bindata/go-bindata The former package is unmainatained since a while and the replacement also fixes this bug I encountered when trying to build the package: jteeuwen/discussions#6 * update Go version requirement in README file * Add a -version flag to Houndd (hound-search#362) This commit adds a `-version` flag to houndd. Running `houndd -version` prints the current version and exits. Co-authored-by: Kartikay Shandil <[email protected]> * Add padding between advanced mode text inputs * add margin bottom to fields that are not last * update front end bundles Co-authored-by: Blobb Ered <@blobbered> * Setup Github Actions CI (hound-search#354) * Setup Github Actions CI Replaces Travis CI with Github Actions for better integration. Jobs are run against more recent Go versions, namely 1.12 to 1.14 . . For further documentation see - https://github.com/actions/setup-go - and https://help.github.com/en/actions This adds `-race` flag to the Go tests and will run a meta linter (golangci-lint). * keep travis in until github workflows is tested * tidy go mods * remove lint command from github workflow * add back go-bindata to go modules list * up version of actions checkout to fix deprecation errors * return go bindata to the go.sum file as well Co-authored-by: Andreas Linz <[email protected]> * Add a github actions badge Thanks again @klingtnet and @blobbered for making this possible! * Update README.md (hound-search#369) Add clarification of using file:// protocol for accessing locally pulled repos * Added new folder docs with config-options description on options. (hound-search#370) * Added new folder docs with config-options description on options. * Peer review comment update updated formatting for config options documentation and added link in readme. * readme link update * link update * Minor edits from code review Co-authored-by: kayyapil <[email protected]> Co-authored-by: ehrktia <[email protected]> Co-authored-by: Salem <[email protected]> * Test windows * Run Go build and test on Ubuntu Linux and Windows * Add lint * Install dependencies in Dockerfile * Fix typo * Adding a tip for windows users (hound-search#379) * Adding a tip for windows users * Update README.md Co-authored-by: Salem <[email protected]> Co-authored-by: Salem <[email protected]> * Use tini as default entry point (hound-search#376) * Add a warning for the default branch rename (hound-search#380) * Add a warning for the default branch rename * Add a link to Github's renaming documentation. * Update README to reflect branch rename. (hound-search#384) * Update version in main.go * support github webhook * Omit ports in constructed URL (hound-search#383) * Improve accessibility (hound-search#398) * Resolve WCAG2AA.Principle3.Guideline3_1.3_1_1.H57.2 * Resolve WCAG2AA.Principle4.Guideline4_1.4_1_2.H91.InputText.Name * Resolve WCAG2AA.Principle4.Guideline4_1.4_1_2.H91.Button.Name * Improve stats contrast * Improve advanced text contrast * Improve repo title contrast * Improve contrast in advanced section * Improve line number contrast * Improve excluded files contrast * Improve "load all" button contrast * Automatically build docker image and publish to ghcr.io (hound-search#401) * Feat: Use goreleaser * Feat: Add docker build, remove goreleaser * Fix: Add image name * Feat: Use ghcr.io and build-push-action@2 * We try again * Trying yet again * Fix: Use actor and GITHUB_TOKEN * Fix: Use github.actor in image tag path * Fix: use github.repository_owner instead of github.actor When you have an organisation, github.actor != github.repository_owner Co-authored-by: Jone Marius Vignes <[email protected]> * Update default-config.json (hound-search#391) * Update default-config.json * Update default-config.json (ref: main) * Add hyperlinks to repository root (hound-search#396) * Add literal search option (hound-search#397) * Add literal search option * Pull EscapeRegExp into common.js * Add db/ to Jest ignore patterns * Test EscapeRegExp() matches its input * Test vacuous EscapeRegExp * Give repo links a target of blank (hound-search#404) Add rel="noopener noreferrer" to _blank links Co-authored-by: Joseph Price <[email protected]> Co-authored-by: dschott <[email protected]> Co-authored-by: Nicolas R <[email protected]> Co-authored-by: Igor <[email protected]> Co-authored-by: Salem <[email protected]> Co-authored-by: Richard Liang <[email protected]> Co-authored-by: Vincent Rischmann <[email protected]> Co-authored-by: Blobb Ered <[email protected]> Co-authored-by: Rebecca Lau <[email protected]> Co-authored-by: Ruixi Fan <[email protected]> Co-authored-by: Ruixi Fan <[email protected]> Co-authored-by: Andreas Linz <[email protected]> Co-authored-by: Rebecca Lau <[email protected]> Co-authored-by: Kartikay Shandil <[email protected]> Co-authored-by: Kartikay Shandil <[email protected]> Co-authored-by: Ashley Roach <[email protected]> Co-authored-by: karthick <[email protected]> Co-authored-by: kayyapil <[email protected]> Co-authored-by: ehrktia <[email protected]> Co-authored-by: David Kolossa <[email protected]> Co-authored-by: Sandro <[email protected]> Co-authored-by: Andrew Stanton <[email protected]> Co-authored-by: David Schott <[email protected]> Co-authored-by: Cor Bosman <[email protected]> Co-authored-by: Jacob Rose <[email protected]> Co-authored-by: Alexander Chiu <[email protected]> Co-authored-by: Joel Armstrong <[email protected]> Co-authored-by: Jone Marius Vignes <[email protected]> Co-authored-by: Jone Marius Vignes <[email protected]> Co-authored-by: Simon Legner <[email protected]> Co-authored-by: Bucky Schwarz <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
issue-#367
Add documentation for all the config options