Docs/quick-docs
2
0
Fork 0
Code Issues 48 Pull requests 1 Projects Releases Packages Wiki Activity Actions

Regular review of QuickDocs articles based on popularity #598

New issue
Closed
opened 2023-05-05 10:12:11 +00:00 by hankuoffroad · 12 comments
hankuoffroad commented 2023-05-05 10:12:11 +00:00
Contributor
Copy link

From Google search analytics for the Docs home page, we could see trends on which articles are most popular. In the Docs home page, most read articles are QuickDocs. In this sense, I would like to suggest regular review based on popularity of QuickDocs how-to guides.

  • Raise awareness: start with sharing list of popular QuickDocs how-to guides on a monthly basis on Discussion
  • Get volunteers for technical review
  • Introduce 'maintainer' concept: if a writer/reviewer is an expert on KVM, they will take ownership of PR/Issue review as a priority.
  • Share the result and progress

I'll take a few Quick Docs articles that I'm interested in and had a major review or rewrite.

  • Package management
  • Change desktop environment
  • Raspberry Pi

Please find the thread in Discussion.

https://discussion.fedoraproject.org/t/docs-site-metrics-google-analytics/81738

Another source of data is Ask Common issues tag. Top three categories in Ask are;

  • Installation
  • Multimedia support
  • Bootloader

We could use QA test result in every release and update the guide.

From Google search analytics for the Docs home page, we could see trends on which articles are most popular. In the Docs home page, most read articles are QuickDocs. In this sense, I would like to suggest regular review based on popularity of QuickDocs how-to guides. - Raise awareness: start with sharing list of popular QuickDocs how-to guides on a monthly basis on Discussion - Get volunteers for technical review - Introduce 'maintainer' concept: if a writer/reviewer is an expert on KVM, they will take ownership of PR/Issue review as a priority. - Share the result and progress I'll take a few Quick Docs articles that I'm interested in and had a major review or rewrite. - Package management - Change desktop environment - Raspberry Pi Please find the thread in Discussion. https://discussion.fedoraproject.org/t/docs-site-metrics-google-analytics/81738 Another source of data is Ask Common issues tag. Top three categories in Ask are; - Installation - Multimedia support - Bootloader We could use QA test result in every release and update the guide.
hankuoffroad commented 2023-05-05 10:12:23 +00:00
Author
Contributor
Copy link

Metadata Update from @hankuoffroad:

  • Issue assigned to hankuoffroad
**Metadata Update from @hankuoffroad**: - Issue assigned to hankuoffroad
hankuoffroad commented 2023-05-05 10:13:15 +00:00
Author
Contributor
Copy link

Issue tagged with: help wanted

Issue tagged with: help wanted
ankursinha commented 2023-05-05 11:23:11 +00:00
Contributor
Copy link

+1

Two things I can think of (which i think we've discussed on discussion.fp.o):

  • send "help wanted" e-mails to the devel lists to make experts aware that there is documentation that can use their help (I'm not sure if folks would serve as maintainers, but it's worth a try)
  • send out regular analytics on docs as a way to raise awareness in the community about how important they are?

Edit: not posting on discussions too, since this seems to be the primary ticket for this already

+1 Two things I can think of (which i think we've discussed on discussion.fp.o): - send "help wanted" e-mails to the devel lists to make experts aware that there is documentation that can use their help (I'm not sure if folks would serve as maintainers, but it's worth a try) - send out regular analytics on docs as a way to raise awareness in the community about how important they are? Edit: not posting on discussions too, since this seems to be the primary ticket for this already
hankuoffroad commented 2023-05-05 12:27:49 +00:00
Author
Contributor
Copy link

Great ideas, thanks.

  • Sending emails to experts on devel lists sounds like a plan.
    One-off help is much appreciated in the beginning. Maintainer concept could be a longshot, but worth trying for certain experts.

  • Correct on analytics to raise awareness: I'm thinking of monthly Docs analytics and work in progress in this ticket.

Great ideas, thanks. - Sending emails to experts on devel lists sounds like a plan. One-off help is much appreciated in the beginning. Maintainer concept could be a longshot, but worth trying for certain experts. - Correct on analytics to raise awareness: I'm thinking of monthly Docs analytics and work in progress in this ticket.
hankuoffroad commented 2023-05-08 20:16:54 +00:00
Author
Contributor
Copy link

Metadata Update from @hankuoffroad:

  • Issue set to the milestone: QuickDocs site metrics
**Metadata Update from @hankuoffroad**: - Issue set to the milestone: QuickDocs site metrics
hankuoffroad commented 2023-08-02 21:13:45 +00:00
Author
Contributor
Copy link

Metadata Update from @hankuoffroad:

  • Assignee reset
**Metadata Update from @hankuoffroad**: - Assignee reset
hankuoffroad commented 2023-08-08 20:33:13 +00:00
Author
Contributor
Copy link

I have to drop this, sorry as in the thread below. But I would leave this open for now if someone else can vote up and assist.

https://discussion.fedoraproject.org/t/86435/3

I have to drop this, sorry as in the thread below. But I would leave this open for now if someone else can vote up and assist. https://discussion.fedoraproject.org/t/86435/3
hankuoffroad commented 2023-10-01 10:23:25 +00:00
Author
Contributor
Copy link

I could use the search stats to prioritize technical review for the writing workshop.

Top 10 pages viewed on the Docs Home page: Apr-Sep 2023

  • EPEL
  • dnf upgrade
  • firewalld
  • creating-and-using-a-live-installation-image
  • installing-chromium-or-google-chrome-browsers
  • Working_with_the_GRUB_2_Boot_Loader
  • rpm fusion
  • adding-or-removing-software-repositories-in-fedora
  • installing java
  • switching-desktop-environments
I could use the search stats to prioritize technical review for the writing workshop. Top 10 pages viewed on the Docs Home page: Apr-Sep 2023 - EPEL - dnf upgrade - firewalld - creating-and-using-a-live-installation-image - installing-chromium-or-google-chrome-browsers - Working_with_the_GRUB_2_Boot_Loader - rpm fusion - adding-or-removing-software-repositories-in-fedora - installing java - switching-desktop-environments
hankuoffroad commented 2023-10-01 10:23:32 +00:00
Author
Contributor
Copy link

Metadata Update from @hankuoffroad:

  • Issue assigned to hankuoffroad
**Metadata Update from @hankuoffroad**: - Issue assigned to hankuoffroad
hankuoffroad commented 2023-10-01 10:28:36 +00:00
Author
Contributor
Copy link

Metadata Update from @hankuoffroad:

  • Issue priority set to: next meeting (was: awaiting triage)
**Metadata Update from @hankuoffroad**: - Issue priority set to: next meeting (was: awaiting triage)
hankuoffroad commented 2023-12-31 22:27:01 +00:00
Author
Contributor
Copy link

Top 10 pages viewed on the Docs Home page: Jan-Dec 2023. Closing this due to inactivity.

EPEL
dnf system upgrade
firewalld
creating-and-using-a-live-installation-image
https://docs.fedoraproject.org/en-US/releases/f39/
Working_with_the_GRUB_2_Boot_Loader
https://docs.fedoraproject.org/en-US/releases/f38/
Installing Java
adding-or-removing-software-repositories-in-fedora
upgrading-fedora-offline

Top 10 pages viewed on the Docs Home page: Jan-Dec 2023. Closing this due to inactivity. EPEL dnf system upgrade firewalld creating-and-using-a-live-installation-image https://docs.fedoraproject.org/en-US/releases/f39/ Working_with_the_GRUB_2_Boot_Loader https://docs.fedoraproject.org/en-US/releases/f38/ Installing Java adding-or-removing-software-repositories-in-fedora upgrading-fedora-offline
hankuoffroad commented 2023-12-31 22:27:01 +00:00
Author
Contributor
Copy link

Metadata Update from @hankuoffroad:

  • Issue close_status updated to: stale
  • Issue status updated to: Closed (was: Open)
**Metadata Update from @hankuoffroad**: - Issue close_status updated to: stale - Issue status updated to: Closed (was: Open)
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
No results found.
Labels
Clear labels   
bug

Something isn't working

  
Closed As
complete
Closed with the reason of complete

  
Closed As
duplicate
Closed with the reason of duplicate

  
Closed As
insufficient data
Closed with the reason of insufficient data

  
Closed As
moved
Closed with the reason of moved

  
Closed As
not possible
Closed with the reason of not possible

  
Closed As
out of scope
Closed with the reason of out of scope

  
Closed As
stale
Closed with the reason of stale

  
good first issue

Good for newcomers (if you want to get involved, try working on one of these!)

  
help wanted

Anyone is welcome to help us with this!

  
improvement

Improves on something that already exists

  
needs changes

Needs changes or fixes before closing

  
needs committer review

Needs review by a person with committer privileges or a subject-matter expert (SME)

  
needs info

Extra attention or information needed

  
new change

Adds new capabilities or functionality

  
Priority
awaiting triage
Priority of awaiting triage

  
Priority
needs review
Priority of needs review

  
Priority
next meeting
Priority of next meeting

  
Priority
waiting on assignee
Priority of waiting on assignee

  
Priority
waiting on external
Priority of waiting on external

No labels
bug
Closed As
complete
Closed As
duplicate
Closed As
insufficient data
Closed As
moved
Closed As
not possible
Closed As
out of scope
Closed As
stale
good first issue
help wanted
improvement
needs changes
needs committer review
needs info
new change
Priority
awaiting triage
Priority
needs review
Priority
next meeting
Priority
waiting on assignee
Priority
waiting on external
Milestone
Clear milestone
No items
No milestone
QuickDocs site metrics
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: Docs/quick-docs#598
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?