Updated ToC for entire ManageIQ + added already existing topics within ToC

[qahmed1998]

Added following additional topics to ToC:

• Creating a Service in for Virtual Machine Provisioning
• Service Provisioning Using an Orchestration Template
• Assigning a Custom Analysis Profile to a Virtual Machine

This PR is editing the current ToC for ManageIQ. No files in terms of their locations were moved in the process. 3 existing topics (as mentioned above) were added to the ToC.

[Fryguy]

@qasim-ahmed This PR is going to need a bunch of "prior" entries, so that the page detector can understand how the pages were moved around. Basically, the way it works is for each of these "moved" sections, just add a new key called "prior" which is the url for the old location of the file. Here's an example from when we moved one of the locations from morphy to najdorf: https://github.com/ManageIQ/manageiq-documentation/blob/najdorf/_data/site_menu.yml#L42

[Fryguy]

@qasim-ahmed Can you also update the original post here with maybe a screenshot or a manual type-out of the new layout? Also, please update the PR title / commit message to be more descriptive - this is a pretty big change, and the title doesn't really reflect that.

[qahmed1998]

Installing section:

Upgrading section:

Administration section:

Visualizing section:

Controls section:

Managing integrations section:

APIs, Reference and Troubleshhooting sections:

[Fryguy]

@agrare @jrafanie Please also take a look.

[qahmed1998]

Hi @agrare @jrafanie Please take a look when you get a chance.

[jrafanie]

@qahmed1998 how can I see a before and after?

It's hard to visualize what's moving around and being added/removed. I'll add my comments but they're on the existing terminology so mostly unrelated to this PR.

[qahmed1998]

@qahmed1998 how can I see a before and after?

It's hard to visualize what's moving around and being added/removed. I'll add my comments but they're on the existing terminology so mostly unrelated to this PR.

We can potentially merge and see the ToC?

[agrare]

We can potentially merge and see the ToC?

I think that defeats the purpose of PR review if we have to merge it to see it, agree with @jrafanie it is hard to review without seeing what has changed easier

[qahmed1998]

I have posted screenshots above as well. The ss might help!

[jrafanie]

Ok, this is the before... I think I can imagine what it will look like:

[qahmed1998]

The changes in this PR include, adding new top level headings, moving topics from one heading to another and adding topics which existed but were not part of the ToC. The ToC changes that are in this PR currently aligns with the downstream (AIOps) ToC.

[agrare]

The ToC changes that are in this PR currently aligns with the downstream (AIOps) ToC.

Okay it seems like some items might be in the wrong place there then also so lets put them in the best place upstream first :tm: and go from there

[qahmed1998]

The ToC changes that are in this PR currently aligns with the downstream (AIOps) ToC.

Okay it seems like some items might be in the wrong place there then also so lets put them in the best place upstream first ™️ and go from there

Yeah sounds good to me.

[agrare]

NOTE I don't see Automation Management Providers in the existing TOC, can we add under Managing Providers similar to Configuration Providers

[qahmed1998]

NOTE I don't see Automation Management Providers in the existing TOC, can we add under Managing Providers similar to Configuration Providers

Do you have the URL/path of the file/content?

[agrare]

https://www.manageiq.org/docs/reference/latest/managing_providers/#automation-management-providers

[qahmed1998]

Okay so from our discussions in Slack, this is what we have as updated ToC.

Installing

Upgrading

Using

• General Configuration

• Monitoring, alerts, reporting

• Policies and Profiles Guide

• Managing Infrastructure and Inventory

• Managing Providers and its sub-topics

• Provisioning Virtual Machines and Hosts

• Scripting Actions in ManageIQ

• Creating a Service in for Virtual Machine Provisioning

• Service Provisioning Using an Orchestration Template

• Managing controls (seems the most suitable name to me as a heading)

  • Monitoring, alerts, reporting

  • Policies and Profiles Guide

• Assigning a Custom Analysis Profile to a Virtual Machine

Administering Infrastructure Management

• Authentication

• Backup and Restore (appliances)

• Deployment planning guide

• High Availability Guide

• Appliance Hardening Guide

Defining integrations

• AWS CloudFormation and OpenStack Heat

• ServiceNow

APIs

• REST API

Reference

• Capabilities Matrix

• Methods available for automation

Troubleshooting (same as it is)

[qahmed1998]

Any final adjustments or am I good to make this as the ToC in the PR?

[jrafanie]

Okay so from our discussions in Slack, this is what we have as updated ToC.

Looks good to me for reorganizing things! We can iterate on it going forward.

[qahmed1998]

Updated ToC as we discussed. Please review.

• Updated the ToC
• Added Automation Management Providers topic in ToC
• Changed description of a topic
• Added Chargeback topic in ToC

[qahmed1998]

@jrafanie @Fryguy are we good to merge?

[qahmed1998]

Hi Joe, I have addressed your comments.

[miq-bot]

Checked commits https://github.com/qahmed1998/manageiq-documentation/compare/3079587d88e28940b52fe996bee972f09d0319f6~...2557ad90b37268668779bfb4586603782985029e with ruby 3.1.5, rubocop 1.56.3, haml-lint 0.51.0, and yamllint 1 file checked, 1 offense detected

**

• [ ] :bomb: :boom: :fire: :fire_engine: - Linter/Yaml - missing config files

[Fryguy]

This PR broke the build

https://github.com/ManageIQ/manageiq-documentation/actions/runs/10814819288/job/30002189898#step:5:232

Psych::SyntaxError: (/tmp/manageiq-documentation/_data/site_menu.yml): mapping values are not allowed in this context at line 7 column 17
/tmp/manageiq-documentation/Rakefile:10:in `block in <top (required)>'
/opt/hostedtoolcache/Ruby/2.7.8/x64/bin/bundle:23:in `load'
/opt/hostedtoolcache/Ruby/2.7.8/x64/bin/bundle:23:in `<main>'
Tasks: TOP => build
(See full trace by running task with --trace)

[Fryguy]

Should be fixed by https://github.com/ManageIQ/manageiq-documentation/pull/1812

[jrafanie]

Weird it passed in the PR. 😕

[Fryguy]

This PR also "broke" the user reference page - https://github.com/ManageIQ/manageiq.org/blob/master/site/docs/reference/index.md?plain=1

I wonder if instead of hardcoding the sections we can more dynamically build it up. Even so, the {{}} stuff won't work there because it's dynamically built.

[jrafanie]

This PR also "broke" the user reference page - https://github.com/ManageIQ/manageiq.org/blob/master/site/docs/reference/index.md?plain=1

I wonder if instead of hardcoding the sections we can more dynamically build it up. Even so, the {{}} stuff won't work there because it's dynamically built.

@qahmed1998 see above