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

As a content contributor, I need to know how to redirect an existing guide that has been restructured.

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Major Major
    • None
    • None
    • Upstream-docs
    • None
    • Quarkus Upstream Docs Sprint 1, Quarkus Upstream Docs Sprint 2

      To migrate existing content topics over to the diataxis content types by using Quarkus templates, we need to rename most (but not all) of the files to the <category><keywords><content_type>.adoc file naming syntax.

      This breaks existing bookmarks that the Quarkus users/readers have created for content on the Quarkus docs portal.

      We need to implement redirects for every source file that gets modified during the restructuring project.

      For example:

      In PR https://github.com/quarkusio/quarkus/pull/29418 we rename:

      • `security.adoc` to `security-overview-concept.adoc`
      • `security-getting-started.adoc` to `security-overview-concept.adoc`

      This task is done when:

      We have content in the contributor guide that explains exactly how to apply a redirect for files that get renamed to minimize user disruption.

      SME: gsmet@redhat.com

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

                Created:
                Updated:
                Resolved: