GODRIVER-2287 Add section to troubleshooting FAQ per driver with top SEO results #1017
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
|
Do we want to link resources from the docs directory in the top level README.md file? |
matthewdale
reviewed
Jul 8, 2022
matthewdale
reviewed
Jul 11, 2022
benjirewis
reviewed
Jul 11, 2022
Co-authored-by: Benjamin Rewis <32186188+benjirewis@users.noreply.github.com>
Co-authored-by: Benjamin Rewis <32186188+benjirewis@users.noreply.github.com>
Co-authored-by: Benjamin Rewis <32186188+benjirewis@users.noreply.github.com>
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.
GODRIVER-2287
We are adding a
docsdirectory at the top level of the Go Driver project. Looking through trending go projects it's pretty noticeable thatdocsis a fairly constant practice, I have only seen a few instances ofdoc(although one of these includes the standard library) and one instance ofdocumentation. Within our organization, many of the drivers have some variation of a docs directory:mongo-ruby-driver
mongo-rust-driver
mongo-node-driver
mongo-python-driver
mongo-cxx-driver
mongo-csharp-driver
The team has decided to stick with markdown over RST. Naming the FAQ file from this context
common-issuesmatches what is being done in the python and ruby drivers.Of the six issues proposed , five of them were unique:
GODRIVER-1763
GODRIVER-854
GODRIVER-1721
GODRIVER-1772
GODRIVER-627
GODRIVER-1763 and GODRIVER-1772 are both unresolved, GODRIVER-1721 is more of a drivers questions than a Go Drivers question. Hence, of the five unique SEO proposals, I believe only two of them are valid for Go Driver documentation:
GODRIVER-854
GODRIVER-627
Along with the
common-issues.md, I've also included theCONTRIBUTING.mdin the docs directory.