Task: Remove Vagrant Documentation from Magma Documentation Repository

[lucaaamaral]

Task: Remove Vagrant Documentation from Magma Documentation Repository

Objective

Remove all Vagrant-related documentation from the magma/magma-documentation repository, as part of the approved plan to deprecate and remove Vagrant deployment in the Magma project (see Issue #15754).

Background

The Magma Technical Steering Committee (TSC) has approved the deprecation and removal of Vagrant-based deployment in Magma. The deprecation announcement will be made in the next release, with full removal of Vagrant support scheduled for the following release. As part of this process, all Vagrant-related documentation must be removed from the magma/magma-documentation repository to align with the updated deployment strategy focusing on agw_docker_install.sh and the deployment repository.

Task Details

1. Identify Vagrant-Related Documentation

   • Search the magma/magma-documentation repository for all files and sections referencing Vagrant deployment, including:
     • Setup guides for Vagrant.
     • References to Vagrantfile or Vagrant-specific configurations.
     • Any tutorials, examples, or FAQs mentioning Vagrant.
   • Document the list of files/sections to be modified or deleted.

2. Remove Vagrant Documentation

   • Delete or update identified files to remove all Vagrant-related content.
   • Ensure no residual references to Vagrant remain in the documentation.
   • Verify that removal does not disrupt references to alternative deployment methods (e.g., agw_docker_install.sh or the deployment repository).

3. Update Related Documentation

   • Add a note in the main documentation (e.g., README or deployment overview) stating that Vagrant deployment has been deprecated and removed, directing users to agw_docker_install.sh and the deployment repository.
   • Include a reference to the migration guide (to be created separately, as per Issue #15754) for users transitioning from Vagrant to alternative methods.

4. Testing and Validation

   • Validate that all Vagrant-related content has been removed by searching the repository for keywords like "Vagrant," "Vagrantfile," or related terms.
   • Ensure that the remaining documentation is consistent, functional, and correctly references alternative deployment methods.
   • Test documentation links to confirm no broken references remain.

5. Pull Request and Review

   • Submit a pull request to the magma/magma-documentation repository with the changes.
   • Include a clear description in the PR, referencing Issue #15754 and the TSC approval.
   • Request review from the Magma documentation maintainers.

Timeline

• Start Date: Align with the next release cycle for the deprecation announcement.
• Completion Date: Complete removal of Vagrant documentation before the release following the deprecation announcement (as per the full deprecation schedule in Issue #15754).
• Key Actions:
  • Identify and document Vagrant-related content.
  • Remove/update documentation and validate changes.
  • Submit and address feedback on the pull request.

Notes

• The deprecation announcement will be made in the next Magma release, so ensure documentation updates align with this timeline.
• Coordinate with the team creating the migration guide to ensure users have clear instructions for transitioning to agw_docker_install.sh or the deployment repository.
• Engage with the Magma community (e.g., Slack or GitHub Discussions) to address any questions or concerns about the removal of Vagrant documentation.

Acceptance Criteria

• All Vagrant-related documentation is removed from the magma/magma-documentation repository.
• A note about Vagrant deprecation and removal is added to the main documentation, with pointers to alternative deployment methods.
• No broken links or references remain in the documentation.
• The pull request is approved and merged by the Magma documentation maintainers.

[lucaaamaral]

Assigned to @emmanuelmaia

[DarshanCode2005]

@emmanuelmaia are you still working on this issue? Would love to give my input on this.