Current status of the Quick Docs migration

We are currently in the process of converting Quick Docs articles to categories and tags and removing the navigation bar.

We have 108 Quick Docs articles. 50 articles are currently added with categories / tags.
Over the next 4–6 weeks we should be able to add about 20-30 more articles.

I’m wondering if we shouldn’t switch the Quick Docs landing page to categories / tags with Release 39, but keep the navigation bar until the last article is added.

We could then contribute to the release party with this move.

What do you guys think?

2 Likes

Do you need any help with updating categories and tags? I couldn’t keep up with bulk update ideas due to other preparations. Please let me know the list of articles to add categories and tags.

Over the next 4–6 weeks we should be able to add about 20-30 more articles.

What topics do you consider for new articles? If there is anything I can do, I’m happy to take them on.

1 Like

@HKL Thanks for the offer. With status today, we have 109 Quick Docs articles and 78 include the complete set of metadata. I think, it’s not that bad. If you could find the time to help, would be wonderful.

I’m just going the alphabetical order of files in the main directory from bottom upwards. The next file to work on is firewalld.adoc. But here it’s not only metadata, but the partials have to get into the main text body, too. As you said earlier, this is a job that drives you nuts. So it’s probably nothing for you.

The next files which just need metadata are:
debug-wayland-problems.adoc
creating-windows-virtual…adoc
contribute-to-quick-docs.adoc
all files in bugzilla subdir
all files in accessibility subdir

I always take the last modified date from the footer as best guess for last reviewed, and look at the history to find previous authors.

We also need to decide whether we want to combine all articles in one directory or group them in subdirectories. In the latter case, we have to take measures that even if you remove the article name in the address line, no 404 is generated. In the former case, we need to move all the corresponding files, assign an alias of the old position and prefix the name with e.g. bugzilla to keep them together.

In retrospect, it is tricky to go ahead.

Do you have a complete list of categories? Here is a list in Quick Docs guide.

  • Administration
  • Installation
  • Managing software
  • Upgrading

I want to ensure consistency in categorization. Some virtualization category is also spelled differently as ‘virtualisation’, which could be counted a different category.

We also need to decide whether we want to combine all articles in one directory or group them in subdirectories. In the latter case, we have to take measures that even if you remove the article name in the address line, no 404 is generated. In the former case, we need to move all the corresponding files, assign an alias of the old position and prefix the name with e.g. bugzilla to keep them together.

I didn’t know many things you consider.

Currently, 87 of 108 articles are provided with metadata. We have plenty of time to follow up with the rest.

Sorry, I couldn’t get on with metadata update right away as I learned there are a couple of things you do at the same time.

I’ll contribute to content review and any new articles on Quick Docs within my remit and interest :slight_smile:

  • Screen recording: technical review
  • Password management: new article
  • Toolbox use case: new article

I’m also thinking of doing it live during Docs workshop. Happy to discuss.

1 Like

Yes, I suppose it is most efficient I work (alone) on all remaining articles. I’ve developed a routine by now, so I can sort of do it on the side.

Reviews are the next important stage. And then also the review of the categories used. If you start something there, I think it would be more helpful and efficient than if you start to work on the migration of the articles now.

1 Like

As of today, all QD articles include a category and one or more tags.

The next step is to decide and prepare a new starting page and maybe a modified design on the article pages.

Suggestions and ideas welcome!

1 Like

Thanks for taking a huge effort with updating metadata and bringing partials back to articles so people can edit pages easily.

I recall the left-hand side navigation menu will phase out and we will expect something on the rightt-hand (or top) space.

Desktop

  • Top tags by number count
  • Top categories
  • New solutions
  • Location: right

Mobile/tablet

  • Top tags: max 7 to 8
  • Location: top
  • Optional button for sorting and data range

Source of ideas: from an external project I’m affiliated with (link below)

1 Like