Uploaded image for project: 'Quarkus Documentation'
  1. Quarkus Documentation
  2. QDOCS-11

Document the process for preparing VS Code for developing Quarkus content

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Major Major
    • None
    • None
    • POC1-prework
    • None
    • Red Hat build of Quarkus

      As a Red Hat writer on the Quarkus team, I need information and instructions on how to best set up my Visual Studio Code authoring tools to harmoniously and efficiently work in both the upstream and downstream Quarkus doc repos:

      GitLab = https://gitlab.cee.redhat.com/quarkus-documentation/quarkus

      GitHub = https://github.com/quarkusio/quarkus and other upstream repos in https://github.com/quarkusio

       

      Most of the CCS technical writer training content is focused on Atom and other IDEs. For the Quarkus docs team, the consensus is that VS Code best supports the docs-as-code approach to content authoring, git workflows and using multiple Git Platforms simultaneously.

       

      Personas:

      • New Red Hat employee who has just joined the company and CCS.
      • Experienced Red Hat writer who has just joined the Quarkus team who has been using the Atom or other editor until now.

      Goal:

       [Definition of Done]- This task is done when we have an enablement resource doc for our Upstream docs/New writers onboarding material that contains the minimum steps to get Visual Studio Code installed and configured with the Workspaces and extensions that will be needed for content authoring in both upstream and downstream projects.

        1. image-2022-06-08-14-06-51-501.png
          image-2022-06-08-14-06-51-501.png
          33 kB

              mpurcell@redhat.com Michelle Purcell
              mpurcell@redhat.com Michelle Purcell
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: