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

Add instructions for building and testing with Rust #35725

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

foursixnine
Copy link

@foursixnine foursixnine commented Dec 19, 2024

Right now, it's a manual search and replace, I would like to build the docs as I find myself the answers to enable my own rust workflows beyond what https://github.com/foursixnine/cndk8/blob/main/.github/workflows/rust.yml is already doing.

was initially: #35721 but panik.

PoC: Add documentation for rust workflows

Why:

Because there's no documentation on how to properly handle rust stuff on github

would take a look later at github/docs/issues/23181 and see what else fails

What's being changed (if available, include any code snippets, screenshots, or gifs):

So far adding documentation based off the Golang one, and my own journey through https://github.com/foursixnine/cndk8/ and isototest-ng

Commits, PR's will be listed

Check off the following:

Still WIP:

  • Update filename
  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require a SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Dec 19, 2024
@foursixnine foursixnine changed the title Oxidizegithub Add instructiuons for building and testing rust Dec 19, 2024
@foursixnine foursixnine changed the title Add instructiuons for building and testing rust Add instructions for building and testing with Rust Dec 20, 2024
@nguyenalex836
Copy link
Contributor

@foursixnine Thanks so much for opening a PR! I'll get this triaged for review ✨Just a quick tip - we'd recommend opening an issue before raising a PR, especially for larger scale changes such as this one 💛 This will let our team determine how best to proceed with the concern / issue you are raising, thank you!

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Dec 20, 2024
@foursixnine
Copy link
Author

@foursixnine Thanks so much for opening a PR! I'll get this triaged for review ✨Just a quick tip - we'd recommend opening an issue before raising a PR

absolutely! I'm behind on creating the issue, was getting: https://github.com/foursixnine/cndk8/actions/runs/12436473960 in shape before, so I'll get back to creating the issue over the weekend :) to not lose momentum!

especially for larger scale changes such as this one 💛 This will let our team determine how best to proceed with the concern / issue you are raising, thank you!

awesome! I might need guidance, as I'm only looking at only gh community

@nguyenalex836
Copy link
Contributor

@foursixnine Ah gotcha, thank you! ✨ Well I hope you get to have a restful and wonderful weekend 💛

@foursixnine
Copy link
Author

foursixnine commented Dec 22, 2024

@foursixnine Ah gotcha, thank you! ✨ Well I hope you get to have a restful and wonderful weekend 💛

@nguyenalex836 : A lot of rest is being achieved :D - created #35747 as the issue for this and following Pull requests (if any) related to this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants