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

Develop docs 2 #10345

Merged
merged 91 commits into from
Jul 11, 2024
Merged

Develop docs 2 #10345

merged 91 commits into from
Jul 11, 2024

Conversation

a-hariti
Copy link
Collaborator

@a-hariti a-hariti commented Jun 10, 2024

Platforms changes for developer docs

cutoff point

Author: Michi Hoffmann <[email protected]>
Date:   Thu Jul 11 01:22:18 2024 +0200

    Update requests.mdx (#1332)

Introduces two npm scripts for developer docs:

  1. Dev
 yarn dev:developer-docs 
  1. Build
yarn build:developer-docs

TODO:

  • port <JsonSchema /> component and its logic
  • add data-schemas submodule dependency
  • port Dependabot logic to update it automatically
  • sidebar nesting
  • home page
  • sitemap
  • 👇 revert build npm script to build sdk docs and use build:developer-docs instead
  • merge proper build scripts for dev docs and sdk docs #10617
  • limit vercel.json redirects to hostname
    • account for preview subdomains
    • port latest redirects fromvercel.json on master
  • fix breadcrums
  • fix Github CTA
  • Algolia search for developer docs
  • skip build logic
  • add a blip of context to:
    • develop-docs/backend/index.mdx
    • develop-docs/services/index.mdx
  • set up DEVELOP_DOCS_INDEX_NAME on github

@a-hariti a-hariti requested a review from a team as a code owner July 9, 2024 12:35
Zylphrex and others added 3 commits July 10, 2024 10:07
* Update github.mdx

* Update sso.mdx
…1330)

* restructure docs and clarify ingest setup

* fix copy paste errors

* fix link location

* fix link location again

* fix missing backticks

* move getsentry instructions above siloed instance instructions

* bug

* properly bold text
This reverts commit 619ec78.
This reverts commit 1f46763.
@stephanie-anderson stephanie-anderson merged commit 60ba25a into master Jul 11, 2024
9 checks passed
@stephanie-anderson stephanie-anderson deleted the develop-docs-2 branch July 11, 2024 13:43
sentrivana pushed a commit that referenced this pull request Jul 16, 2024
* remove unused docs prop

* add getDevDocsFrontMatter()

* escape {} braces

* fix image path

* fix comment block

* fix style prop

* fix me later

* fix comments

* fix me later

* delete seemingly invisible <IconFire /> components on component-library

* account for developer docs on middleware redirects

* fix opentelemetry table syntax

* port configValue component

* temp fix for github integration

* port createGitHubAppForm component

* oopsy

* reaname DEVELOPER_DOCS env var

* remove console.logs

* fix developer docs  home page

* force preview to show developer docs for now

* make TS happy

* feat: account for developer docs on sitemap

* fix missing slash on sitemap entries

* simplify sitemap logic

* refactor: extract developer docs check to its own module

* hide sidebar for now

* add host condition to sdk docs wildcard redirects

* fix generateStaticParams() depending on kind of docs

* split vercel.json file to base and redirects

* dynamically build vercel.json based on target docs

* throw an error if base-vercel.json has redirects or rewrites

* fix developer docs checks on middleware

* populate serverContext before handling develop-docs paths

* fix develop-docs docTree

* remove unecessary null check

* sidebar (wip)

* feat(flagpole): Updates feature flag docs for Flagpole rollout (#1299)

Co-authored-by: Mark Story <[email protected]>

* doc(metrics): Metric tags can only have a single value (#1307)

* chore(flagpole): Updates documentation with commonly used context properties (#1308)

* feat(insights): asset module documentation (#1306)

* asset module initial docs

* update broken link

* Update assets.mdx

Co-authored-by: George Gritsouk <[email protected]>

* Update assets.mdx

Co-authored-by: George Gritsouk <[email protected]>

* Update assets.mdx

Co-authored-by: George Gritsouk <[email protected]>

* Update assets.mdx

Co-authored-by: George Gritsouk <[email protected]>

* code review

* Update src/docs/sdk/performance/modules/assets.mdx

Co-authored-by: Ash <[email protected]>

* asset data description

* update snippet

* update typos

---------

Co-authored-by: George Gritsouk <[email protected]>
Co-authored-by: Ash <[email protected]>

* Add new mechanism fields from RFC 0079 (#1207)

* docs(migrations): Update is_dangerous -> is_post_deployment (#1310)

* fix: Clarify context keys (#1309)

* feat: Remove DDM

* Document Java SDK learnings for Hubs/Scopes merge (#1251)

* tidy up sidebar items (wip)

* Upgrade to GitHub-native Dependabot (#322)

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
Co-authored-by: Abhijeet Prasad <[email protected]>

* add data data-schemas submodule to develop-docs

* move data-schemas to the top level

* .

* Move content to subfolders; make sure pages use proper MDX for titles

* wip

* SDK Philosophy - Write less code (#1316)

* SDK Philosophy - Write less code

Another addition for our SDK Philosophy

* Update philosophy.mdx

* Update src/docs/sdk/philosophy.mdx

Co-authored-by: Abhijeet Prasad <[email protected]>

---------

Co-authored-by: Michi Hoffmann <[email protected]>
Co-authored-by: Abhijeet Prasad <[email protected]>

* fix: Improve ngrok setup docs (#1317)

Clarify how ngrok should be setup for siloed and non-siloed modes.

Refs getsentry/sentry#14423

* chore(hybridcloud) Add sentry_region to flagpole docs (#1318)

* feat(feedback): add page for feedback architecture (#1313)

* feat(feedback): add a page for feedback architecture

* Camelcase for model name

* Add diagrams

* Add some whitespace

* Header capitalizion

* Update src/docs/feedback-architecture.mdx

Co-authored-by: Catherine Lee <[email protected]>

* Update src/docs/feedback-architecture.mdx

Co-authored-by: Michelle Zhang <[email protected]>

* Update src/docs/feedback-architecture.mdx

Co-authored-by: Michelle Zhang <[email protected]>

* Update src/docs/feedback-architecture.mdx

Co-authored-by: Michelle Zhang <[email protected]>

* Update src/docs/feedback-architecture.mdx

Co-authored-by: Michelle Zhang <[email protected]>

* Update src/docs/feedback-architecture.mdx

Co-authored-by: Michelle Zhang <[email protected]>

* Update src/docs/feedback-architecture.mdx

Co-authored-by: Michelle Zhang <[email protected]>

* Add to bottom of sidebar as 'User Feedback Architecture'

* Make diagrams light mode

* Tweak ##Creation sources wording

* Add links to envelope formats in Creation sources + some more tweaks

* Code-ify user_report

* Reword mistakenly

* Tweak diagrams: envelopes->envelope and rm widget/api from first graph

* Reword user report endpoint

* Add crash reports section

* Split up diagrams and finalize

* Tweak feedback envelope

* Update report diagram

* Update title

* Add ff's

* Use bullet points

* Tweak ff descrip

* Final tweaks

---------

Co-authored-by: Catherine Lee <[email protected]>
Co-authored-by: Michelle Zhang <[email protected]>

* fix(flagpole): Fixes incorrect segment behavior description (#1322)

* fix: Update docs on running migration tests (#1323)

* Revert "wip"

This reverts commit a504ca4.

* formatting

* fix redirect type

* Use frontmatter for all page titles

* Fix title for performance page

* formatting

* somewhat working JsonSchema

* update git submodules before build

* feat: build algolia index conditionally

* switch git submodules to https

* feat(migrations): add docs for snapshots & backup testing (#1324)

* feat(features) Add note to remove features from options-automator (#1325)

* chore(hybridcloud) Update hybridcloud examples to use new paths (#1326)

Paths have changed and docs need to be updated.

* Discord "SDK Contributor" chat is no longer used. Moved to "SDK-Chat" (#1328)

* conditionally skip builds based on APP_NAME env var and changes

APP_NAME should be either `sdk-docs` or `develop-docs`

* document skip-build script

* simplify skip-build.sh logic

* suppress console.log warning

* really?

* docs: Document bump version workflow (#1329)

* Extend github integration docs (#1235)

* Update github.mdx

* Update sso.mdx

* fix(environment): restructure subheadings and clarify ingest setup (#1330)

* restructure docs and clarify ingest setup

* fix copy paste errors

* fix link location

* fix link location again

* fix missing backticks

* move getsentry instructions above siloed instance instructions

* bug

* properly bold text

* chore: re-trigger deploy

* proper build scripts for dev docs and sdk docs (#10617)

* re-trigger deploy

This reverts commit 619ec78.

* re-trigger deploy

This reverts commit 1f46763.

* fix dev build command

* fix: update algolia workflow

* fix: load correct frontmatter in algolia build

* [getsentry/action-github-commit] Auto commit

* fix: set env var for gh action

---------

Co-authored-by: Gabe Villalobos <[email protected]>
Co-authored-by: Mark Story <[email protected]>
Co-authored-by: Joris Bayer <[email protected]>
Co-authored-by: Dominik Buszowiecki <[email protected]>
Co-authored-by: George Gritsouk <[email protected]>
Co-authored-by: Ash <[email protected]>
Co-authored-by: Emir Ribić <[email protected]>
Co-authored-by: Isabella Enriquez <[email protected]>
Co-authored-by: Francesco Novy <[email protected]>
Co-authored-by: Matej Minar <[email protected]>
Co-authored-by: Alexander Dinauer <[email protected]>
Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
Co-authored-by: Abhijeet Prasad <[email protected]>
Co-authored-by: Stephanie Anderson <[email protected]>
Co-authored-by: Daniel Griesser <[email protected]>
Co-authored-by: Michi Hoffmann <[email protected]>
Co-authored-by: Andrew Liu <[email protected]>
Co-authored-by: Catherine Lee <[email protected]>
Co-authored-by: Michelle Zhang <[email protected]>
Co-authored-by: Alberto Leal <[email protected]>
Co-authored-by: Charly Gomez <[email protected]>
Co-authored-by: Simon Hellmayr <[email protected]>
Co-authored-by: Joe Malatesta <[email protected]>
Co-authored-by: Tony Xiao <[email protected]>
Co-authored-by: Lucas <[email protected]>
Co-authored-by: Michelle Fu <[email protected]>
Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>
@github-actions github-actions bot locked and limited conversation to collaborators Jul 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.