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

planning docs #100

Merged
merged 7 commits into from
Dec 7, 2024
Merged

planning docs #100

merged 7 commits into from
Dec 7, 2024

Conversation

daniel-noland
Copy link
Collaborator

@daniel-noland daniel-noland commented Nov 28, 2024

image

Unfortunately this commit required changes to dpdk-sys to build. As a result, we lost nightly-sterile builds in a commit where I normally would not have messed with that.

@qmonnet
Copy link
Member

qmonnet commented Nov 29, 2024

It builds but the preview is broken for me, the link to most pages are invalid

@daniel-noland daniel-noland force-pushed the planning branch 29 times, most recently from 0fec5c9 to ccfce87 Compare November 30, 2024 23:24
@daniel-noland daniel-noland marked this pull request as ready for review December 5, 2024 19:21
@daniel-noland daniel-noland requested a review from a team as a code owner December 5, 2024 19:21
@daniel-noland daniel-noland requested review from qmonnet and removed request for a team December 5, 2024 19:22
@daniel-noland daniel-noland self-assigned this Dec 5, 2024
@daniel-noland daniel-noland added the design related to high level design label Dec 5, 2024
@daniel-noland daniel-noland force-pushed the planning branch 3 times, most recently from c6b0a25 to 5b4fa3d Compare December 6, 2024 03:14
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

The changes look good, but please split-up this PR into logical commit (or PRs?). The change in CI, in source code, or in the build framework seem unrelated to the doc additions.

dpdk-sys

1. no longer provides nightly builds for sterile
2. made some adjustments to the wrte wrapper which required some minor renaming.
3. changed the name of the docker images

This PR accounts for this
The javascript had gotten a little messy (frankly it still is), but it is far less chaotic now.

Significant chunks of commented code have been removed.
The svg elements are being embedded with directly set width and height values.

This overrides the CSS style they should be getting, so just move the assigned setting to style attributes.
No need to carry around .js files for mermaid.
This was used in another project and somehow made it in to this one.
Remove.
Expand and re-organize docs to add in design work by the whole team.
@daniel-noland
Copy link
Collaborator Author

The changes look good, but please split-up this PR into logical commit (or PRs?). The change in CI, in source code, or in the build framework seem unrelated to the doc additions.

This should be resolved now. I appreciate the attention to detail.

Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

Looks so much cleaner now, thank you! 👍

* [@Fredi-raspall]
* coordinate with: [@daniel-noland]

{{#include ../../links.md}}
Copy link
Member

Choose a reason for hiding this comment

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

I know that with Sphinx, there's an option to include this sort of stuff automatically in the footer of all pages. I don't know if mdBook (on a quick look, I couldn't find an equivalent option). Anyway, doesn't matter much.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, I could make it work. I just didn't try that hard for such a small thing

@qmonnet
Copy link
Member

qmonnet commented Dec 6, 2024

Looks all good to me, you can merge it or wait for more reviews if your prefer

@daniel-noland daniel-noland added this pull request to the merge queue Dec 7, 2024
Merged via the queue into main with commit be2d97f Dec 7, 2024
14 checks passed
@daniel-noland daniel-noland deleted the planning branch December 7, 2024 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design related to high level design
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants