suma ia review information plan

Information Plan

The Information Plan …​ is the primary document you will use to plan how to manage the publications project, providing the basis for your preliminary estimates of the schedule and budget needed to complete the project.

Goals and Objectives of the Development Project

Information architecture (IA) focuses on organizing, structuring, and labeling content in an effective and sustainable way. The goal is to use our user profile to accurately areas of improvement that will help our users find the information they need to complete their tasks as related to Uyuni/SUMA.

Organizing Data (Making sense of the mess)

How do we organize the collection of resources we currently have into one that fits our user profile and logically guides them through tasks? We should try and answer this here. We also must simultaneously keep in mind our technical ecosystem and the vision we have for our process:

Vision Refinement:

Tooling

• Antora (In Progress Depends largely on our IA rework - Contact me lana for a demo)

• Ascidoctor (In good shape - process works, but we need to refine it via automation)

• fennek2 (Image processing works with fennek v1, however migration to chrome-headless needs to be completed for react components. This could take a full sprint due to the shear volume of code. Our future goal should be to combine this with an automation system that contains Uyuni/suma in a preconfigured state. Allowing the capture of predefined image states.)

• Algolia (Simple to add via a javascript plugin, nothing to maintain. Works out of the box. Although we could refine our index for accuracy - low prio.)

• SUSE Toolchain (DAPS requirements? I think DAPS is only necessary for packing jsp files for the WebUI. Technically we can get around this via asciidoctor itself. For now we can stick with it as the process works.)

• Automation (Travisci, jenkins, etc. Automate build and push to SUSE.com/docs and SUMA WebUI RPMs) What is the plan for our entire automation process, can we create some simple scripts for our Antora pages to accomplish this? Research needed. "1 sprint"

• Jekyll Blog (Will be used temporarily for a "news" or "blog" posts module. Probably the easiest way to implement recent articles and can be stored and linked to another repo.) Dan Allen and I had a brief discussion about a possible "news" component added to antora at a later time.

Tooling Resources:

• [Asciidoctor](https://asciidoctor.org/)

• [Antora - Static Site Generator Based on Asciidoc](https://antora.org/)

• [Fennek V1 - PhantomJS - Deprecated](https://github.com/openSUSE/fennek)

• [Fennek V2 - Chrome Headless](https://github.com/jcayouette/fennek2)

• [Algolia Docsearch](https://community.algolia.com/docsearch/)

• [Jekyll](https://jekyllrb.com/)

Community

• GitHub (How will we organize Uyuni/SUMA products? Antora Components and Asciidoctor entities are one solution.)

• Web presence (I am already sold on Antora as it is written by the author of asciidoctor and fits our model of contribution and simplicity. The real question is where do we host?)

• Community (Establish a community, keep community in mind during all of our decision making, twitter, gitter, technical blog, maintain contact with developers of adoc and help push innovation to improve our process. I have already begun speaking with Dan Allen @mojavelinux, author of Asciidoctor/Antora.)

Structuring the Data and Distribution System

Creating Rules for New Content

Goals and Objectives for the Publications

Preliminary User Profile

• Administrators (Internal/External)

• Sales and Field Engineers (External)

• Chief Information Officers(CIO) (External)

• Developers/QA (Internal/External)

• Doc Writers (Interal/future external opensource)

• New Uyuni Open Source Community (Developers/Engineers/Administrators)

High-Level Task Analysis

Design Implications and Publications Strategy

• Keep in mind day 2 docs. What can customers do AFTER they get the basics.

Preliminary Media Selection

Project Plan

The Project Plan takes the creative ideas of the Information Plan and sets a course for their development …​ A Project Plan that carefully specifies what can be built in the allotted time and at the designated level of quality removes some of the risk.

Estimate of Scope and Complexity

Estimate of Time and Budget

Estimate of Required Resources

Milestone Schedule

Roles of Responsibilities of Team Members

Production Plan

Localisation & Translation Plan

Testing Plan

Maintenance Plan