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

Doc improvements before the NSF project wrap-up #3143

Open
12 of 14 tasks
robgjansen opened this issue Sep 5, 2023 · 1 comment
Open
12 of 14 tasks

Doc improvements before the NSF project wrap-up #3143

robgjansen opened this issue Sep 5, 2023 · 1 comment
Labels
Component: Documentation In-repository documentation, under docs/
Milestone
Documentation

Comments

@robgjansen
Copy link
Member

robgjansen commented Sep 5, 2023 •
edited

  • Scan existing code and see where improvements to code docs are needed:
    • Structs / module-level documentation
    • public funcs
    • deprecated funcs or coding patterns
  • Review maintainer documentation:
    • instructions for running clippy, miri, etc locally
    • instructions for testing specific crates since shadow is slow to build/test (ex: cd src/lib/foo && cargo test)
  • Review existing policies and see if any should be updated for 'maintenance' mode:
    • Supported OSes, kernels
    • Code review
    • Required tests
    • Expectations for contributing to Shadow
    • When to use which containers where?
      • RootedRefCell/RootedRc is faster but requires host
      • and we're not sure how much it matters
  • Code cleanup
  • Issue a new Shadow release
@robgjansen robgjansen added the Type: Bug Error or flaw producing unexpected results label Sep 5, 2023
@robgjansen robgjansen added this to the Documentation milestone Sep 5, 2023
@robgjansen robgjansen added Component: Documentation In-repository documentation, under docs/ and removed Type: Bug Error or flaw producing unexpected results labels Sep 6, 2023
@robgjansen
Copy link
Member Author

See also #2737

@robgjansen robgjansen changed the title Doc improvements before the NSF project ends Doc improvements before the NSF project wrap-up Sep 26, 2023
@sporksmith sporksmith pinned this issue Sep 26, 2023
@robgjansen robgjansen mentioned this issue Jan 1, 2024
Merged
robgjansen added a commit that referenced this issue Jan 2, 2024
@robgjansen
CI and repo maintenance (#3264)
8ad0cb6 
- Rust was already updated in #3257
- Codecov access has now been revoked (as decided in #3143)

Closes #3197
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Component: Documentation In-repository documentation, under docs/
Projects
None yet
Milestone
Documentation
Development

No branches or pull requests
1 participant
@robgjansen