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

Reorganize and improve documentation #322

Merged
merged 2 commits into from
Feb 20, 2024
Merged

Conversation

benjaminjkraft
Copy link
Collaborator

We've been in need of a documentation revamp for a while; a giant FAQ was never the greatest structure and got worse as it grew. In this commit I reorganize the documentation. Most of it is just moving around existing text, but I added some new documentation here and there.

The changes:

  • Many of the FAQ questions have moved to several new docs, on the client/runtime, handling your schema, and various operation types; the FAQ has answers to a few of the actually most frequent questions, as well as a few things that didn't fit elsewhere.
  • We now have a docs/README.md which acts as an index, so we can just link to /docs.
  • I lowercased the files that don't need match a GitHub convention, so it's a bit less yell-y.
  • I added documentation on:

Reviewers, you can see what it all looks like together here.

Fixes #245.

I have:

  • Written a clear PR title and description (above)
  • Signed the Khan Academy CLA
  • Added tests covering my changes, if applicable (n/a)
  • Included a link to the issue fixed, if applicable
  • Included documentation, for new features
  • Added an entry to the changelog (n/a)

We've been in need of a documentation revamp for a while; a giant FAQ
was never the greatest structure and got worse as it grew. In this
commit I reorganize the documentation. Most of it is just moving around
existing text, but I added some new documentation here and there.

The changes:
- Many of the FAQ questions have moved to several new docs, on the
  client/runtime, handling your schema, and various operation types; the
  FAQ has answers to a few of the actually most frequent questions, as
  well as a few things that didn't fit elsewhere.
- We now have a `docs/README.md` which acts as an index, so we can just
  link to `/docs`.
- I lowercased the files that don't need match a GitHub convention, so
  it's a bit less yell-y.
- I added documentation on:
  - how we version genqlient (fixes #63)
  - newer options for optional types
  - a bit more on custom scalars and integer types (fixes #128)
Copy link
Member

@StevenACoffman StevenACoffman left a comment

Choose a reason for hiding this comment

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

nice!

@benjaminjkraft benjaminjkraft merged commit ae275ac into main Feb 20, 2024
10 checks passed
@benjaminjkraft benjaminjkraft deleted the benkraft.docs-reorg branch February 20, 2024 05:02
dmitryax pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Mar 12, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [github.com/Khan/genqlient](https://togithub.com/Khan/genqlient) |
`v0.6.0` -> `v0.7.0` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fKhan%2fgenqlient/v0.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fKhan%2fgenqlient/v0.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fKhan%2fgenqlient/v0.6.0/v0.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fKhan%2fgenqlient/v0.6.0/v0.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

> [!WARNING]
> Some dependencies could not be looked up. Check the Dependency
Dashboard for more information.

---

### Release Notes

<details>
<summary>Khan/genqlient (github.com/Khan/genqlient)</summary>

### [`v0.7.0`](https://togithub.com/Khan/genqlient/releases/tag/v0.7.0)

[Compare
Source](https://togithub.com/Khan/genqlient/compare/v0.6.0...v0.7.0)

In addition to several new features and bugfixes, along with this
release comes reorganized
[documentation](https://togithub.com/Khan/genqlient/blob/main/docs) for
genqlient. Note that genqlient now requires Go 1.20 or higher, and is
tested through Go 1.22.

#### What's Changed

- Add "generic" option to the "optional" configuration for handling
nullable types by
[@&#8203;DylanRJohnston](https://togithub.com/DylanRJohnston) in
[Khan/genqlient#252
- Documentation tweaks relating to releases by
[@&#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#271
- Add some better tests for use_struct_references by
[@&#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#273
- Add an option to handle enums with ugly casing by
[@&#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#270
- Add some more tests for config validation, and fix some gaps by
[@&#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#274
- Add consideration for pointer false directive when optional: pointer
configuration option is used by
[@&#8203;spencermurray](https://togithub.com/spencermurray) in
[Khan/genqlient#280
- Update gqlparser and gqlgen dependencies by
[@&#8203;StevenACoffman](https://togithub.com/StevenACoffman) in
[Khan/genqlient#282
- Update gqlparser to omit comments by
[@&#8203;StevenACoffman](https://togithub.com/StevenACoffman) in
[Khan/genqlient#284
- bugfix: local variable 'data' colliding with argument name by
[@&#8203;zholti](https://togithub.com/zholti) in
[Khan/genqlient#291
- Pin lint workflow's Go version by
[@&#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#311
- Upgrade golangci-lint and which go we run it with by
[@&#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#314
- fix implementation type generation for fragment on a union by
[@&#8203;zzh8829](https://togithub.com/zzh8829) in
[Khan/genqlient#310
- Support more valid graphql file extensions by
[@&#8203;zzh8829](https://togithub.com/zzh8829) in
[Khan/genqlient#309
- Add tests on Go 1.22, and upgrade x/tools to make them work by
[@&#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#315
- Update gqlgen to latest by
[@&#8203;StevenACoffman](https://togithub.com/StevenACoffman) in
[Khan/genqlient#317
- move genqlient Go module to 1.20 by
[@&#8203;StevenACoffman](https://togithub.com/StevenACoffman) in
[Khan/genqlient#318
- Improve package-sniffing and bind correctly to types in the same
package by [@&#8203;benjaminjkraft](https://togithub.com/benjaminjkraft)
in
[Khan/genqlient#316
- Reorganize and improve documentation by
[@&#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#322
- Fix non-deterministic generated code involving interfaces and
fragments. by [@&#8203;csilvers](https://togithub.com/csilvers) in
[Khan/genqlient#323
- Release v0.7.0 by
[@&#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#324

#### New Contributors

- [@&#8203;DylanRJohnston](https://togithub.com/DylanRJohnston) made
their first contribution in
[Khan/genqlient#252
- [@&#8203;spencermurray](https://togithub.com/spencermurray) made their
first contribution in
[Khan/genqlient#280
- [@&#8203;zholti](https://togithub.com/zholti) made their first
contribution in
[Khan/genqlient#291
- [@&#8203;zzh8829](https://togithub.com/zzh8829) made their first
contribution in
[Khan/genqlient#310

**Full Changelog**:
Khan/genqlient@v0.6.0...v0.7.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "on tuesday" (UTC), Automerge - At any
time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/open-telemetry/opentelemetry-collector-contrib).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yMjAuMiIsInVwZGF0ZWRJblZlciI6IjM3LjIyMC4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com>
Co-authored-by: Andrzej Stencel <astencel@sumologic.com>
DougManton pushed a commit to DougManton/opentelemetry-collector-contrib that referenced this pull request Mar 13, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [github.com/Khan/genqlient](https://togithub.com/Khan/genqlient) |
`v0.6.0` -> `v0.7.0` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fKhan%2fgenqlient/v0.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fKhan%2fgenqlient/v0.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fKhan%2fgenqlient/v0.6.0/v0.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fKhan%2fgenqlient/v0.6.0/v0.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

> [!WARNING]
> Some dependencies could not be looked up. Check the Dependency
Dashboard for more information.

---

### Release Notes

<details>
<summary>Khan/genqlient (github.com/Khan/genqlient)</summary>

### [`v0.7.0`](https://togithub.com/Khan/genqlient/releases/tag/v0.7.0)

[Compare
Source](https://togithub.com/Khan/genqlient/compare/v0.6.0...v0.7.0)

In addition to several new features and bugfixes, along with this
release comes reorganized
[documentation](https://togithub.com/Khan/genqlient/blob/main/docs) for
genqlient. Note that genqlient now requires Go 1.20 or higher, and is
tested through Go 1.22.

#### What's Changed

- Add "generic" option to the "optional" configuration for handling
nullable types by
[@&open-telemetry#8203;DylanRJohnston](https://togithub.com/DylanRJohnston) in
[Khan/genqlient#252
- Documentation tweaks relating to releases by
[@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#271
- Add some better tests for use_struct_references by
[@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#273
- Add an option to handle enums with ugly casing by
[@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#270
- Add some more tests for config validation, and fix some gaps by
[@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#274
- Add consideration for pointer false directive when optional: pointer
configuration option is used by
[@&open-telemetry#8203;spencermurray](https://togithub.com/spencermurray) in
[Khan/genqlient#280
- Update gqlparser and gqlgen dependencies by
[@&open-telemetry#8203;StevenACoffman](https://togithub.com/StevenACoffman) in
[Khan/genqlient#282
- Update gqlparser to omit comments by
[@&open-telemetry#8203;StevenACoffman](https://togithub.com/StevenACoffman) in
[Khan/genqlient#284
- bugfix: local variable 'data' colliding with argument name by
[@&open-telemetry#8203;zholti](https://togithub.com/zholti) in
[Khan/genqlient#291
- Pin lint workflow's Go version by
[@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#311
- Upgrade golangci-lint and which go we run it with by
[@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#314
- fix implementation type generation for fragment on a union by
[@&open-telemetry#8203;zzh8829](https://togithub.com/zzh8829) in
[Khan/genqlient#310
- Support more valid graphql file extensions by
[@&open-telemetry#8203;zzh8829](https://togithub.com/zzh8829) in
[Khan/genqlient#309
- Add tests on Go 1.22, and upgrade x/tools to make them work by
[@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#315
- Update gqlgen to latest by
[@&open-telemetry#8203;StevenACoffman](https://togithub.com/StevenACoffman) in
[Khan/genqlient#317
- move genqlient Go module to 1.20 by
[@&open-telemetry#8203;StevenACoffman](https://togithub.com/StevenACoffman) in
[Khan/genqlient#318
- Improve package-sniffing and bind correctly to types in the same
package by [@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft)
in
[Khan/genqlient#316
- Reorganize and improve documentation by
[@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#322
- Fix non-deterministic generated code involving interfaces and
fragments. by [@&open-telemetry#8203;csilvers](https://togithub.com/csilvers) in
[Khan/genqlient#323
- Release v0.7.0 by
[@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#324

#### New Contributors

- [@&open-telemetry#8203;DylanRJohnston](https://togithub.com/DylanRJohnston) made
their first contribution in
[Khan/genqlient#252
- [@&open-telemetry#8203;spencermurray](https://togithub.com/spencermurray) made their
first contribution in
[Khan/genqlient#280
- [@&open-telemetry#8203;zholti](https://togithub.com/zholti) made their first
contribution in
[Khan/genqlient#291
- [@&open-telemetry#8203;zzh8829](https://togithub.com/zzh8829) made their first
contribution in
[Khan/genqlient#310

**Full Changelog**:
Khan/genqlient@v0.6.0...v0.7.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "on tuesday" (UTC), Automerge - At any
time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/open-telemetry/opentelemetry-collector-contrib).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yMjAuMiIsInVwZGF0ZWRJblZlciI6IjM3LjIyMC4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com>
Co-authored-by: Andrzej Stencel <astencel@sumologic.com>
XinRanZhAWS pushed a commit to XinRanZhAWS/opentelemetry-collector-contrib that referenced this pull request Mar 13, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [github.com/Khan/genqlient](https://togithub.com/Khan/genqlient) |
`v0.6.0` -> `v0.7.0` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fKhan%2fgenqlient/v0.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fKhan%2fgenqlient/v0.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fKhan%2fgenqlient/v0.6.0/v0.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fKhan%2fgenqlient/v0.6.0/v0.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

> [!WARNING]
> Some dependencies could not be looked up. Check the Dependency
Dashboard for more information.

---

### Release Notes

<details>
<summary>Khan/genqlient (github.com/Khan/genqlient)</summary>

### [`v0.7.0`](https://togithub.com/Khan/genqlient/releases/tag/v0.7.0)

[Compare
Source](https://togithub.com/Khan/genqlient/compare/v0.6.0...v0.7.0)

In addition to several new features and bugfixes, along with this
release comes reorganized
[documentation](https://togithub.com/Khan/genqlient/blob/main/docs) for
genqlient. Note that genqlient now requires Go 1.20 or higher, and is
tested through Go 1.22.

#### What's Changed

- Add "generic" option to the "optional" configuration for handling
nullable types by
[@&open-telemetry#8203;DylanRJohnston](https://togithub.com/DylanRJohnston) in
[Khan/genqlient#252
- Documentation tweaks relating to releases by
[@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#271
- Add some better tests for use_struct_references by
[@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#273
- Add an option to handle enums with ugly casing by
[@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#270
- Add some more tests for config validation, and fix some gaps by
[@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#274
- Add consideration for pointer false directive when optional: pointer
configuration option is used by
[@&open-telemetry#8203;spencermurray](https://togithub.com/spencermurray) in
[Khan/genqlient#280
- Update gqlparser and gqlgen dependencies by
[@&open-telemetry#8203;StevenACoffman](https://togithub.com/StevenACoffman) in
[Khan/genqlient#282
- Update gqlparser to omit comments by
[@&open-telemetry#8203;StevenACoffman](https://togithub.com/StevenACoffman) in
[Khan/genqlient#284
- bugfix: local variable 'data' colliding with argument name by
[@&open-telemetry#8203;zholti](https://togithub.com/zholti) in
[Khan/genqlient#291
- Pin lint workflow's Go version by
[@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#311
- Upgrade golangci-lint and which go we run it with by
[@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#314
- fix implementation type generation for fragment on a union by
[@&open-telemetry#8203;zzh8829](https://togithub.com/zzh8829) in
[Khan/genqlient#310
- Support more valid graphql file extensions by
[@&open-telemetry#8203;zzh8829](https://togithub.com/zzh8829) in
[Khan/genqlient#309
- Add tests on Go 1.22, and upgrade x/tools to make them work by
[@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#315
- Update gqlgen to latest by
[@&open-telemetry#8203;StevenACoffman](https://togithub.com/StevenACoffman) in
[Khan/genqlient#317
- move genqlient Go module to 1.20 by
[@&open-telemetry#8203;StevenACoffman](https://togithub.com/StevenACoffman) in
[Khan/genqlient#318
- Improve package-sniffing and bind correctly to types in the same
package by [@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft)
in
[Khan/genqlient#316
- Reorganize and improve documentation by
[@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#322
- Fix non-deterministic generated code involving interfaces and
fragments. by [@&open-telemetry#8203;csilvers](https://togithub.com/csilvers) in
[Khan/genqlient#323
- Release v0.7.0 by
[@&open-telemetry#8203;benjaminjkraft](https://togithub.com/benjaminjkraft) in
[Khan/genqlient#324

#### New Contributors

- [@&open-telemetry#8203;DylanRJohnston](https://togithub.com/DylanRJohnston) made
their first contribution in
[Khan/genqlient#252
- [@&open-telemetry#8203;spencermurray](https://togithub.com/spencermurray) made their
first contribution in
[Khan/genqlient#280
- [@&open-telemetry#8203;zholti](https://togithub.com/zholti) made their first
contribution in
[Khan/genqlient#291
- [@&open-telemetry#8203;zzh8829](https://togithub.com/zzh8829) made their first
contribution in
[Khan/genqlient#310

**Full Changelog**:
Khan/genqlient@v0.6.0...v0.7.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "on tuesday" (UTC), Automerge - At any
time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/open-telemetry/opentelemetry-collector-contrib).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yMjAuMiIsInVwZGF0ZWRJblZlciI6IjM3LjIyMC4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com>
Co-authored-by: Andrzej Stencel <astencel@sumologic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants