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.

Sign up for GitHub

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

Jump to bottom

[docs][observability] O11y refactor 2 #35279

Merged
merged 33 commits into from
May 22, 2023
Merged

[docs][observability] O11y refactor 2 #35279

merged 33 commits into from
May 22, 2023

Conversation

angelinalg
Copy link
Contributor

Why are these changes needed?

Refactoring observability content to improve the user experience and organization of content.

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

@angelinalg angelinalg mentioned this pull request May 12, 2023
Closed
@angelinalg
rename overview content to key concepts
50f9291 
Signed-off-by: angelinalg <[email protected]>
@angelinalg
new page for getting started on observability with programmatic inter…
59a0ed8 
…faces

Signed-off-by: angelinalg <[email protected]>
@angelinalg
Merge branch 'master' into o11y-refactor-2
c035142
@angelinalg
move content to new page for config and manage dashboard
8ea2d44 
Signed-off-by: angelinalg <[email protected]>
@angelinalg
populating configure dashboard doc and moving to clusters section
529187f 
Signed-off-by: angelinalg <[email protected]>
@angelinalg
forgot to save changes
f18b2b8 
Signed-off-by: angelinalg <[email protected]>
@angelinalg
change title name on side nav
cacd619 
Signed-off-by: angelinalg <[email protected]>
@angelinalg
change title name on side nav
794130f 
Signed-off-by: angelinalg <[email protected]>
@angelinalg
changing headers and titles to gerunds for consistency
ce42aba 
Signed-off-by: angelinalg <[email protected]>
@angelinalg
remove overview, rename dashboard page to getting started
32618ab 
Signed-off-by: angelinalg <[email protected]>
@angelinalg
fixed file location to move up a level
1448b4d 
Signed-off-by: angelinalg <[email protected]>
@angelinalg
fixed titles
f19deaf 
Signed-off-by: angelinalg <[email protected]>
@angelinalg
another iteration of titles to fit side nav better
408bc0f 
Signed-off-by: angelinalg <[email protected]>
@angelinalg
Merge branch 'master' into o11y-refactor-2
0af82b9
@angelinalg
create reference subdirectory; moved content for cli GS and metrics
e78de8d 
Signed-off-by: angelinalg <[email protected]>
@angelinalg
add youtube links for overview and jobs videos
6827e25 
Signed-off-by: angelinalg <[email protected]>
@angelinalg
add five youtube links; fix anchors for api and cli refs
0819a37 
Signed-off-by: angelinalg <[email protected]>
@angelinalg
add two youtube links
d5f5558 
Signed-off-by: angelinalg <[email protected]>
@angelinalg
moving some misplaced logging content; fixed extra blank spaces after…
399e9b8 
… videos; moved programmatic monitoring to user guides

Signed-off-by: angelinalg <[email protected]>
@angelinalg
fixing links
b32a6b8 
Signed-off-by: angelinalg <[email protected]>
@angelinalg
fixing merge conflicts
181b0cf 
Signed-off-by: angelinalg <[email protected]>
@angelinalg
fixing broken test and broken note
68019c1 
Signed-off-by: angelinalg <[email protected]>
richardliaw
richardliaw approved these changes May 22, 2023
View reviewed changes
Copy link
Contributor

@richardliaw richardliaw left a comment

Choose a reason for hiding this comment

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

stamp for docs

@Yard1 Yard1 merged commit 668384d into ray-project:master May 22, 2023
2 checks passed
@angelinalg angelinalg deleted the o11y-refactor-2 branch May 22, 2023 23:54
angelinalg added a commit to angelinalg/ray that referenced this pull request Jun 1, 2023
@angelinalg
[docs][observability] O11y refactor 2 (ray-project#35279)
1d658e3 
Refactoring observability content to improve the user experience and organization of content.

---------

Signed-off-by: angelinalg <[email protected]>
@angelinalg angelinalg mentioned this pull request Jun 1, 2023
Merged
7 tasks
ArturNiederfahrenhorst pushed a commit that referenced this pull request Jun 5, 2023
@angelinalg @simran-2797
Cherry pick docs PRs for contributor page, landing page, o11y (#35969)
c9ce481 
* [docs]workaround when local build doesn't render correctly (#35765)

* [docs]Made the install ray card clickable (#35783)

The installation card on the landing page was not clickable. This PR fixes that.

* [docs][observability] O11y refactor 2 (#35279)

Refactoring observability content to improve the user experience and organization of content.

---------

Signed-off-by: angelinalg <[email protected]>

* [docs] fixing broken references, links, note (#35694)

* [docs][observability]fix flow of writing in Getting Started 4/N (#35762)

Signed-off-by: angelinalg <[email protected]>

---------

Signed-off-by: angelinalg <[email protected]>
Co-authored-by: Simran Mhatre <[email protected]>
scv119 pushed a commit to scv119/ray that referenced this pull request Jun 16, 2023
@angelinalg @scv119
[docs][observability] O11y refactor 2 (ray-project#35279)
51e93bb 
Refactoring observability content to improve the user experience and organization of content.

---------

Signed-off-by: angelinalg <[email protected]>
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
@angelinalg @arvind-chandra
[docs][observability] O11y refactor 2 (ray-project#35279)
d5bd063 
Refactoring observability content to improve the user experience and organization of content.

---------

Signed-off-by: angelinalg <[email protected]>
Signed-off-by: e428265 <[email protected]>
glennmoy pushed a commit to beacon-biosignals/ray that referenced this pull request Sep 26, 2023
@angelinalg @simran-2797 @glennmoy
Cherry pick docs PRs for contributor page, landing page, o11y (ray-pr…
dec3acf 
…oject#35969)

* [docs]workaround when local build doesn't render correctly (ray-project#35765)

* [docs]Made the install ray card clickable (ray-project#35783)

The installation card on the landing page was not clickable. This PR fixes that.

* [docs][observability] O11y refactor 2 (ray-project#35279)

Refactoring observability content to improve the user experience and organization of content.

---------

Signed-off-by: angelinalg <[email protected]>

* [docs] fixing broken references, links, note (ray-project#35694)

* [docs][observability]fix flow of writing in Getting Started 4/N (ray-project#35762)

Signed-off-by: angelinalg <[email protected]>

---------

Signed-off-by: angelinalg <[email protected]>
Co-authored-by: Simran Mhatre <[email protected]>
glennmoy pushed a commit to beacon-biosignals/ray that referenced this pull request Sep 26, 2023
@angelinalg @simran-2797 @glennmoy
Cherry pick docs PRs for contributor page, landing page, o11y (ray-pr…
6a800b7 
…oject#35969)

* [docs]workaround when local build doesn't render correctly (ray-project#35765)

* [docs]Made the install ray card clickable (ray-project#35783)

The installation card on the landing page was not clickable. This PR fixes that.

* [docs][observability] O11y refactor 2 (ray-project#35279)

Refactoring observability content to improve the user experience and organization of content.

---------

Signed-off-by: angelinalg <[email protected]>

* [docs] fixing broken references, links, note (ray-project#35694)

* [docs][observability]fix flow of writing in Getting Started 4/N (ray-project#35762)

Signed-off-by: angelinalg <[email protected]>

---------

Signed-off-by: angelinalg <[email protected]>
Co-authored-by: Simran Mhatre <[email protected]>
glennmoy pushed a commit to beacon-biosignals/ray that referenced this pull request Sep 26, 2023
@angelinalg @simran-2797 @glennmoy
Cherry pick docs PRs for contributor page, landing page, o11y (ray-pr…
805e9a2 
…oject#35969)

* [docs]workaround when local build doesn't render correctly (ray-project#35765)

* [docs]Made the install ray card clickable (ray-project#35783)

The installation card on the landing page was not clickable. This PR fixes that.

* [docs][observability] O11y refactor 2 (ray-project#35279)

Refactoring observability content to improve the user experience and organization of content.

---------

Signed-off-by: angelinalg <[email protected]>

* [docs] fixing broken references, links, note (ray-project#35694)

* [docs][observability]fix flow of writing in Getting Started 4/N (ray-project#35762)

Signed-off-by: angelinalg <[email protected]>

---------

Signed-off-by: angelinalg <[email protected]>
Co-authored-by: Simran Mhatre <[email protected]>
glennmoy pushed a commit to beacon-biosignals/ray that referenced this pull request Sep 26, 2023
@angelinalg @simran-2797 @glennmoy
Cherry pick docs PRs for contributor page, landing page, o11y (ray-pr…
19d0aeb 
…oject#35969)

* [docs]workaround when local build doesn't render correctly (ray-project#35765)

* [docs]Made the install ray card clickable (ray-project#35783)

The installation card on the landing page was not clickable. This PR fixes that.

* [docs][observability] O11y refactor 2 (ray-project#35279)

Refactoring observability content to improve the user experience and organization of content.

---------

Signed-off-by: angelinalg <[email protected]>

* [docs] fixing broken references, links, note (ray-project#35694)

* [docs][observability]fix flow of writing in Getting Started 4/N (ray-project#35762)

Signed-off-by: angelinalg <[email protected]>

---------

Signed-off-by: angelinalg <[email protected]>
Co-authored-by: Simran Mhatre <[email protected]>
glennmoy pushed a commit to beacon-biosignals/ray that referenced this pull request Sep 26, 2023
@angelinalg @simran-2797 @glennmoy
Cherry pick docs PRs for contributor page, landing page, o11y (ray-pr…
daa842e 
…oject#35969)

* [docs]workaround when local build doesn't render correctly (ray-project#35765)

* [docs]Made the install ray card clickable (ray-project#35783)

The installation card on the landing page was not clickable. This PR fixes that.

* [docs][observability] O11y refactor 2 (ray-project#35279)

Refactoring observability content to improve the user experience and organization of content.

---------

Signed-off-by: angelinalg <[email protected]>

* [docs] fixing broken references, links, note (ray-project#35694)

* [docs][observability]fix flow of writing in Getting Started 4/N (ray-project#35762)

Signed-off-by: angelinalg <[email protected]>

---------

Signed-off-by: angelinalg <[email protected]>
Co-authored-by: Simran Mhatre <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@scottsun94 scottsun94 scottsun94 approved these changes

@matthewdeng matthewdeng matthewdeng approved these changes

@richardliaw richardliaw richardliaw approved these changes

@architkulkarni architkulkarni Awaiting requested review from architkulkarni architkulkarni is a code owner

@wuisawesome wuisawesome Awaiting requested review from wuisawesome

@DmitriGekhtman DmitriGekhtman Awaiting requested review from DmitriGekhtman

@maxpumperla maxpumperla Awaiting requested review from maxpumperla maxpumperla is a code owner

@pcmoritz pcmoritz Awaiting requested review from pcmoritz pcmoritz is a code owner

@gjoliver gjoliver Awaiting requested review from gjoliver

@krfricke krfricke Awaiting requested review from krfricke

@xwjiang2010 xwjiang2010 Awaiting requested review from xwjiang2010

@amogkam amogkam Awaiting requested review from amogkam amogkam is a code owner

@Yard1 Yard1 Awaiting requested review from Yard1

@sven1977 sven1977 Awaiting requested review from sven1977 sven1977 is a code owner

@avnishn avnishn Awaiting requested review from avnishn

@ArturNiederfahrenhorst ArturNiederfahrenhorst Awaiting requested review from ArturNiederfahrenhorst ArturNiederfahrenhorst is a code owner

@smorad smorad Awaiting requested review from smorad

@kouroshHakha kouroshHakha Awaiting requested review from kouroshHakha

@ericl ericl Awaiting requested review from ericl ericl is a code owner

@scv119 scv119 Awaiting requested review from scv119 scv119 is a code owner

@c21 c21 Awaiting requested review from c21 c21 is a code owner

@scottjlee scottjlee Awaiting requested review from scottjlee scottjlee is a code owner

@bveeramani bveeramani Awaiting requested review from bveeramani bveeramani is a code owner

@raulchen raulchen Awaiting requested review from raulchen raulchen is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@angelinalg @matthewdeng @richardliaw @scottsun94 @Yard1