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

doc: publish the graphics enablement doc on rtd #3334

Merged
merged 1 commit into from
May 6, 2024

Conversation

mattkae
Copy link
Contributor

@mattkae mattkae commented Apr 17, 2024

What's new?

  • Transferred the Mir bringup guide to a how-to guide in the Mir project
    • Rewrote the document with a focus on graphics-core22. @RAOF please let me know if any of my assumptions about graphics-core22 were incorrect here, since the original document was intended for graphics-core20
  • Published the document on readthedocs

How to test?

  • Open the file in CI

Copy link

codecov bot commented Apr 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.35%. Comparing base (25ade62) to head (06e3b30).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3334      +/-   ##
==========================================
- Coverage   77.36%   77.35%   -0.01%     
==========================================
  Files        1075     1075              
  Lines       68268    68268              
==========================================
- Hits        52813    52812       -1     
- Misses      15455    15456       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mattkae mattkae force-pushed the MIRENG-461-publish-the-graphics-enablement-doc-on-rtd branch from 1a51ad5 to 4765102 Compare April 17, 2024 15:35
@mattkae mattkae marked this pull request as ready for review April 17, 2024 15:58
@mattkae mattkae requested a review from a team as a code owner April 17, 2024 15:58
@mattkae mattkae closed this Apr 17, 2024
@mattkae mattkae reopened this Apr 17, 2024
@mattkae mattkae requested review from Saviq and RAOF April 17, 2024 20:39
Copy link
Contributor

@RAOF RAOF left a comment

Choose a reason for hiding this comment

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

Comments inline

@mattkae
Copy link
Contributor Author

mattkae commented Apr 22, 2024

@RAOF Can you expand a bit more on the following comments, not sure how to address:

@mattkae mattkae requested a review from RAOF April 22, 2024 21:40
Copy link
Contributor

@RAOF RAOF left a comment

Choose a reason for hiding this comment

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

Oh, whoops! I totally missed that we didn't really update for any of the graphics-core22 changes on my first pass through!

That makes it both easier and harder. This is our only documentation on creating a provider snap, and it's a little bare, but perhaps what should be done here is to link out to that and improve it?

Then remove (or, really, move into a better provider creating document) everything from

## How to assemble a `graphics-core22` provider snap

until

## How to test a `graphics-core22` provider snap

@mattkae
Copy link
Contributor Author

mattkae commented Apr 23, 2024

That makes it both easier and harder. This is our only documentation on creating a provider snap, and it's a little bare, but perhaps what should be done here is to link out to that and improve it?

Then remove (or, really, move into a better provider creating document) everything from

## How to assemble a `graphics-core22` provider snap

until

## How to test a `graphics-core22` provider snap

Why would we link out to that though? Shouldn't this document be the document on creating a provider snap, while the other one gets merged into this?

@mattkae mattkae requested a review from RAOF April 23, 2024 18:19
@RAOF
Copy link
Contributor

RAOF commented Apr 24, 2024

If you need help doing or testing a libmali provider, I can poke at it.

@Saviq Saviq changed the title Mireng 461 publish the graphics enablement doc on rtd doc: publish the graphics enablement doc on rtd Apr 24, 2024
@mattkae mattkae requested a review from RAOF April 26, 2024 13:53
@mattkae mattkae force-pushed the MIRENG-461-publish-the-graphics-enablement-doc-on-rtd branch from 7914f1f to bf3f18f Compare April 26, 2024 19:18
@mattkae mattkae requested a review from Saviq April 26, 2024 19:19
Copy link
Contributor

@RAOF RAOF left a comment

Choose a reason for hiding this comment

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

Couple of minor changes, but I think we've got the big stuff!

@mattkae mattkae force-pushed the MIRENG-461-publish-the-graphics-enablement-doc-on-rtd branch from 98fb63f to 88f920f Compare April 30, 2024 13:24
@mattkae mattkae force-pushed the MIRENG-461-publish-the-graphics-enablement-doc-on-rtd branch from 88f920f to 06e3b30 Compare April 30, 2024 13:25
@mattkae mattkae requested a review from RAOF April 30, 2024 13:25
@mattkae
Copy link
Contributor Author

mattkae commented Apr 30, 2024

@RAOF Committed the requested changes and cleaned up the history 🎉

Copy link
Contributor

@RAOF RAOF left a comment

Choose a reason for hiding this comment

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

👍

@RAOF RAOF added this pull request to the merge queue May 6, 2024
Merged via the queue into main with commit 1f08188 May 6, 2024
22 of 25 checks passed
@RAOF RAOF deleted the MIRENG-461-publish-the-graphics-enablement-doc-on-rtd branch May 6, 2024 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants