Development: Migrate integrated code lifecycle documentation
#11770
Conversation
WalkthroughThe PR migrates Integrated Code Lifecycle documentation from Sphinx/reStructuredText format to MDX format. Student-focused content is consolidated into Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
documentation/docs/student/integrated-code-lifecycle.mdx (1)
84-84: Consider using "dropdown" as a single hyphenated word.The phrase "code button drop down" should be "code button dropdown" for consistency with standard UI terminology.
Apply this diff:
-Admins can configure which mechanisms should be available for users, and the order in which they appear in the code button drop down, as described in the Artemis configuration. +Admins can configure which mechanisms should be available for users, and the order in which they appear in the code button dropdown, as described in the Artemis configuration.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (19)
documentation/docs/instructor/assets/integrated-code-lifecycle/build-agent-details.pngis excluded by!**/*.png,!**/*.pngdocumentation/docs/instructor/assets/integrated-code-lifecycle/build-agent-summary.pngis excluded by!**/*.png,!**/*.pngdocumentation/docs/instructor/assets/integrated-code-lifecycle/buildQueueCourseManagement.pngis excluded by!**/*.png,!**/*.pngdocumentation/docs/instructor/assets/integrated-code-lifecycle/buildQueueSystemAdministration.pngis excluded by!**/*.png,!**/*.pngdocumentation/docs/instructor/assets/integrated-code-lifecycle/course-management-repositories.pngis excluded by!**/*.png,!**/*.pngdocumentation/docs/instructor/assets/integrated-code-lifecycle/finished-build-jobs.pngis excluded by!**/*.png,!**/*.pngdocumentation/docs/instructor/assets/integrated-code-lifecycle/open-repository-button.pngis excluded by!**/*.png,!**/*.pngdocumentation/docs/instructor/assets/integrated-code-lifecycle/open-repository-instructor-participations.pngis excluded by!**/*.png,!**/*.pngdocumentation/docs/instructor/assets/integrated-code-lifecycle/queued-build-jobs.pngis excluded by!**/*.png,!**/*.pngdocumentation/docs/instructor/assets/integrated-code-lifecycle/running-build-jobs.pngis excluded by!**/*.png,!**/*.pngdocumentation/docs/student/assets/integrated-code-lifecycle/add-vcs-access-token.pngis excluded by!**/*.png,!**/*.pngdocumentation/docs/student/assets/integrated-code-lifecycle/code-button-extended-authentication.pngis excluded by!**/*.png,!**/*.pngdocumentation/docs/student/assets/integrated-code-lifecycle/commit-diff-view.pngis excluded by!**/*.png,!**/*.pngdocumentation/docs/student/assets/integrated-code-lifecycle/commit-history-view.pngis excluded by!**/*.png,!**/*.pngdocumentation/docs/student/assets/integrated-code-lifecycle/current-repository-content-view.pngis excluded by!**/*.png,!**/*.pngdocumentation/docs/student/assets/integrated-code-lifecycle/open-repository-button.pngis excluded by!**/*.png,!**/*.pngdocumentation/docs/student/assets/integrated-code-lifecycle/open-repository-student.pngis excluded by!**/*.png,!**/*.pngdocumentation/docs/student/assets/integrated-code-lifecycle/open-settings.pngis excluded by!**/*.png,!**/*.pngdocumentation/docs/student/assets/integrated-code-lifecycle/ssh-add-public-key.pngis excluded by!**/*.png,!**/*.png
📒 Files selected for processing (15)
docs/user/icl/general.rst(0 hunks)docs/user/icl/local-ci-build-agent-view.inc(0 hunks)docs/user/icl/local-ci-build-queue-view.inc(0 hunks)docs/user/icl/local-continuous-integration.rst(0 hunks)docs/user/icl/local-vc-authentication.inc(0 hunks)docs/user/icl/local-vc-repository-view.inc(0 hunks)docs/user/icl/local-version-control.rst(0 hunks)docs/user/icl/ssh-add-key-to-artemis.rst(0 hunks)docs/user/icl/ssh-intro.rst(0 hunks)docs/user/icl/ssh-key-creation.rst(0 hunks)docs/user/integrated-code-lifecycle.rst(1 hunks)documentation/docs/instructor/integrated-code-lifecycle.mdx(1 hunks)documentation/docs/student/integrated-code-lifecycle.mdx(1 hunks)documentation/sidebar-instructors.ts(1 hunks)documentation/sidebar-students.ts(1 hunks)
💤 Files with no reviewable changes (10)
- docs/user/icl/local-ci-build-queue-view.inc
- docs/user/icl/local-vc-repository-view.inc
- docs/user/icl/general.rst
- docs/user/icl/ssh-key-creation.rst
- docs/user/icl/local-continuous-integration.rst
- docs/user/icl/local-version-control.rst
- docs/user/icl/ssh-add-key-to-artemis.rst
- docs/user/icl/local-vc-authentication.inc
- docs/user/icl/local-ci-build-agent-view.inc
- docs/user/icl/ssh-intro.rst
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2024-10-08T15:35:42.972Z
Learnt from: magaupp
Repo: ls1intum/Artemis PR: 8802
File: src/main/resources/templates/rust/exercise/src/context.rs:1-1
Timestamp: 2024-10-08T15:35:42.972Z
Learning: Code inside the `exercise` directories in the Artemis platform is provided to students and is intended for them to implement. TODO comments in these directories are meant to guide students and should not be addressed in the PR.
Applied to files:
docs/user/integrated-code-lifecycle.rst
🪛 LanguageTool
documentation/docs/student/integrated-code-lifecycle.mdx
[grammar] ~84-~84: Use a hyphen to join words.
Context: ...hich they appear in the code button drop down, as described in the Artemis config...
(QB_NEW_EN_HYPHEN)
[style] ~87-~87: The phrase ‘have the ability to’ might be wordy. Consider using “can”.
Context: ...button dialog. Instructors additionally have the ability to create an access token, with the abilit...
(HAS_THE_ABILITY_TO)
[style] ~236-~236: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...chine you want to connect to. When you want to connect, your SSH client sends a reques...
(REP_WANT_TO_VB)
[style] ~337-~337: Reusing ‘You’ could be redundant. Try omitting the pronoun.
Context: [email protected] ``` 5. You're done and you can now add your key to Artemis. ### Creat...
(SUBJECT_DROP)
[style] ~415-~415: Reusing ‘You’ could be redundant. Try omitting the pronoun.
Context: ...mis@homemac ~ % ``` 4. You're done and you can now add your key to Artemis. --- ## U...
(SUBJECT_DROP)
documentation/docs/instructor/integrated-code-lifecycle.mdx
[style] ~109-~109: The phrase ‘have the ability to’ might be wordy. Consider using “can”.
Context: ...oved from the queue in real-time. Users have the ability to cancel any job in progress. The table p...
(HAS_THE_ABILITY_TO)
[uncategorized] ~124-~124: Do not mix variants of the same word (‘cancelled’ and ‘canceled’) within a single text.
Context: ...d, with or without a result, failed, or cancelled. Information about finished build jobs ...
(EN_EXACT_COHERENCY_RULE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)
- GitHub Check: Codacy Static Code Analysis
- GitHub Check: Build and Push Docker Image / Build linux/amd64 Docker Image for ls1intum/artemis
- GitHub Check: Build and Push Docker Image / Build linux/arm64 Docker Image for ls1intum/artemis
- GitHub Check: Build .war artifact
- GitHub Check: client-tests
- GitHub Check: client-style
- GitHub Check: server-tests
- GitHub Check: server-style
- GitHub Check: Analyse
- GitHub Check: Mend Security Check
🔇 Additional comments (9)
docs/user/integrated-code-lifecycle.rst (1)
6-16: LGTM! Clean migration approach.The redirect stubs are well-structured and provide clear pointers to the new documentation locations for both student and instructor guides.
documentation/sidebar-students.ts (1)
10-10: LGTM!The sidebar entry is correctly added to expose the new student Integrated Code Lifecycle documentation.
documentation/sidebar-instructors.ts (1)
9-9: LGTM!The sidebar entry is correctly added to expose the new instructor Integrated Code Lifecycle documentation.
documentation/docs/student/integrated-code-lifecycle.mdx (4)
1-37: LGTM!The frontmatter, imports, and introductory content are well-structured and provide a clear overview of the Integrated Code Lifecycle components.
184-263: LGTM!The VCS tokens and SSH introduction sections provide clear, comprehensive guidance for students. The explanations are accessible and well-structured.
267-416: LGTM!The SSH key creation instructions are comprehensive and provide clear step-by-step guidance for Windows, Linux, and macOS users. The examples and command outputs are helpful for verification.
419-469: LGTM!The instructions for adding SSH keys to Artemis and using them for repository operations are clear and well-documented with platform-specific examples.
documentation/docs/instructor/integrated-code-lifecycle.mdx (2)
1-52: LGTM!The frontmatter, imports, and Continuous Integration overview provide a solid foundation for the instructor documentation. The CI concepts are explained clearly.
139-152: LGTM!The Local Version Control section for instructors provides clear instructions on accessing student and exercise repositories with helpful visual references.
github-project-automation
bot
moved this from Work In Progress
to Ready For Review
in Artemis Development
End-to-End (E2E) Test Results Summary
|
||||||||||||||||||||||||
LuisL02
left a comment
LuisL02
left a comment
There was a problem hiding this comment.
Tested the changes locally. The docs work as expected and are easy to understand.
Small remark: Formatting in this section
Checklist
General
Motivation and Context
We want to migrate to the new documentation https://ls1intum.github.io/Artemis/ from https://artemis-platform.readthedocs.io/en/latest/index.html to provide a more modern and user friendly access to additional information around Artemis.
Description
Integrated Code Lifecyclesection to the new documentationStudentandInstructordocumentationSteps for Testing
Run
npm installandnpm startin the/documentationfolderReview Progress
Manual Tests
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.