Skip to content

chore: docs rework#927

Merged
beeme1mr merged 18 commits intomainfrom
chore/web-doc-rework
Sep 27, 2023
Merged

chore: docs rework#927
beeme1mr merged 18 commits intomainfrom
chore/web-doc-rework

Conversation

@toddbaert
Copy link
Copy Markdown
Member

@toddbaert toddbaert commented Sep 21, 2023 •
edited
Loading

Total web-docs overhaul:

  • puts a helpful intro at the start, with a demo on the next page
  • adds an "architecture" page which discusses in-process vs rpc
  • adds a deployment page with mentions how to install/run
  • adds a "reference" section which includes:
    • specs
    • protos (in the form of autogenerated markdown for easy navigation)
    • autogenerated CLI docs
  • adds FAQ

@toddbaert toddbaert requested a review from a team September 21, 2023 19:47
@toddbaert toddbaert marked this pull request as draft September 21, 2023 19:47
@netlify
Copy link
Copy Markdown

netlify bot commented Sep 21, 2023 •
edited
Loading

✅ Deploy Preview for polite-licorice-3db33c ready!

Name Link
🔨 Latest commit 96d2583
🔍 Latest deploy log https://app.netlify.com/sites/polite-licorice-3db33c/deploys/65146925ea3bff00089f65f6
😎 Deploy Preview https://deploy-preview-927--polite-licorice-3db33c.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@codecov
Copy link
Copy Markdown

codecov bot commented Sep 21, 2023 •
edited
Loading

Codecov Report

Merging #927 (96d2583) into main (9065cba) will increase coverage by 72.62%.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           main     #927       +/-   ##
=========================================
+ Coverage      0   72.62%   +72.62%     
=========================================
  Files         0       28       +28     
  Lines         0     2857     +2857     
=========================================
+ Hits          0     2075     +2075     
- Misses        0      685      +685     
- Partials      0       97       +97

see 28 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@toddbaert toddbaert force-pushed the chore/web-doc-rework branch 2 times, most recently from 7f36204 to b0823f6 Compare September 22, 2023 20:20
beeme1mr
beeme1mr reviewed Sep 26, 2023
View reviewed changes
Kavindu-Dodan
Kavindu-Dodan reviewed Sep 26, 2023
View reviewed changes
Kavindu-Dodan
Kavindu-Dodan reviewed Sep 26, 2023
View reviewed changes
Kavindu-Dodan
Kavindu-Dodan reviewed Sep 26, 2023
View reviewed changes
Kavindu-Dodan
Kavindu-Dodan reviewed Sep 26, 2023
View reviewed changes
@toddbaert toddbaert force-pushed the chore/web-doc-rework branch 2 times, most recently from 6318254 to a8e4901 Compare September 27, 2023 14:44
@toddbaert
chore: docs rework
09012e5 
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
@toddbaert
fixup: links in index
28a44d3 
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
@toddbaert toddbaert marked this pull request as ready for review September 27, 2023 16:00
@toddbaert
fixup: remove version from installs
f022fbb 
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
beeme1mr
beeme1mr reviewed Sep 27, 2023
View reviewed changes
toddbaert and others added 6 commits September 27, 2023 12:08
@toddbaert
chore: use-tabbed nav
259a0a7 
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
@toddbaert @beeme1mr
Update docs/quick-start.md
e808ec8 
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
@toddbaert @beeme1mr
Update docs/quick-start.md
6685bab 
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
@toddbaert @beeme1mr
Update docs/quick-start.md
efab473 
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
@toddbaert @beeme1mr
Update docs/quick-start.md
f2c5811 
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
@toddbaert @beeme1mr
Update docs/quick-start.md
bce161e 
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
toddbaert and others added 5 commits September 27, 2023 12:09
@toddbaert @beeme1mr
Update docs/reference/openfeature-operator/installation.md
dbb768d 
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
@toddbaert @beeme1mr
Update docs/reference/specifications/custom-operations/fractional-ope…
0e57430 
…ration-spec.md

Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
@toddbaert @beeme1mr
Update docs/reference/specifications/custom-operations/fractional-ope…
396e7c0 
…ration-spec.md

Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
@toddbaert
fixup: pr feedback
913b64e 
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
@toddbaert
fixup: pr feedback
fdf49dd 
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
beeme1mr
beeme1mr reviewed Sep 27, 2023
View reviewed changes
toddbaert and others added 4 commits September 27, 2023 13:26
@toddbaert @beeme1mr
Update docs/concepts/syncs.md
2272021 
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
@toddbaert @beeme1mr
Update docs/concepts/syncs.md
6a2a555 
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
@toddbaert @beeme1mr
Update docs/quick-start.md
193e9f3 
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
@toddbaert
fixup: remove tabs
96d2583 
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
@beeme1mr beeme1mr merged commit 27b3193 into main Sep 27, 2023
@beeme1mr beeme1mr deleted the chore/web-doc-rework branch September 27, 2023 17:46
@github-actions github-actions bot mentioned this pull request Sep 27, 2023
Merged
@beeme1mr beeme1mr mentioned this pull request Sep 27, 2023
Closed
toddbaert pushed a commit that referenced this pull request Oct 12, 2023
@github-actions
chore: release main (#919)
3dd6929 
🤖 I have created a release *beep* *boop*
---


<details><summary>flagd: 0.6.7</summary>

##
[0.6.7](flagd/v0.6.6...flagd/v0.6.7)
(2023-10-12)


### 🐛 Bug Fixes

* **deps:** update module github.com/open-feature/flagd/core to v0.6.6
([#916](#916))
([1f80e4d](1f80e4d))
* **deps:** update module
github.com/open-feature/go-sdk-contrib/providers/flagd to v0.1.17
([#759](#759))
([a2a2c3c](a2a2c3c))
* **deps:** update module github.com/spf13/viper to v1.17.0
([#956](#956))
([31d015d](31d015d))
* **deps:** update module go.uber.org/zap to v1.26.0
([#917](#917))
([e57e206](e57e206))


### 🧹 Chore

* docs rework ([#927](#927))
([27b3193](27b3193))


### 📚 Documentation

* fixed typos and linting issues
([#957](#957))
([0bade57](0bade57))
</details>

<details><summary>flagd-proxy: 0.2.12</summary>

##
[0.2.12](flagd-proxy/v0.2.11...flagd-proxy/v0.2.12)
(2023-10-12)


### 🐛 Bug Fixes

* **deps:** update module github.com/open-feature/flagd/core to v0.6.6
([#916](#916))
([1f80e4d](1f80e4d))
* **deps:** update module github.com/spf13/viper to v1.17.0
([#956](#956))
([31d015d](31d015d))
* **deps:** update module go.uber.org/zap to v1.26.0
([#917](#917))
([e57e206](e57e206))
</details>

<details><summary>core: 0.6.7</summary>

##
[0.6.7](core/v0.6.6...core/v0.6.7)
(2023-10-12)


### 🐛 Bug Fixes

* **deps:** update module github.com/prometheus/client_golang to v1.17.0
([#939](#939))
([9065cba](9065cba))
* **deps:** update module github.com/rs/cors to v1.10.1
([#946](#946))
([1c39862](1c39862))
* **deps:** update module go.uber.org/zap to v1.26.0
([#917](#917))
([e57e206](e57e206))
* **deps:** update module golang.org/x/mod to v0.13.0
([#952](#952))
([be61450](be61450))
* **deps:** update module golang.org/x/sync to v0.4.0
([#949](#949))
([faa24a6](faa24a6))
* **deps:** update module google.golang.org/grpc to v1.58.1
([#915](#915))
([06d95de](06d95de))
* **deps:** update module google.golang.org/grpc to v1.58.2
([#928](#928))
([90f1878](90f1878))
* **deps:** update module google.golang.org/grpc to v1.58.3
([#960](#960))
([fee1558](fee1558))
* **deps:** update opentelemetry-go monorepo
([#943](#943))
([e7cee41](e7cee41))
* erroneous warning about prop overwrite
([#924](#924))
([673b76a](673b76a))


### ✨ New Features

* add `$flagd.timestamp` to json evaluator
([#958](#958))
([a1b04e7](a1b04e7))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@beeme1mr beeme1mr beeme1mr approved these changes

@Kavindu-Dodan Kavindu-Dodan Awaiting requested review from Kavindu-Dodan

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@toddbaert @beeme1mr @Kavindu-Dodan