Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[HelpHub]: Link Control Page #970

Open
17 tasks
femkreations opened this issue Jul 13, 2023 · 6 comments
Open
17 tasks

[HelpHub]: Link Control Page #970

femkreations opened this issue Jul 13, 2023 · 6 comments
Assignees
Labels
6.3 Changes in 6.3 release medium priority new document Requests for new page/article. self-assigned [Status] In progress Issue is in progress user documentation (HelpHub) Improvements or additions to end-user documentation

Comments

@femkreations
Copy link
Collaborator

New page for 6.3

  • Create a new article for the Link Control page.
  • Make sure the URL slug under Permalink is: link-editing

Update for 6.3

  • Force disable suggestions until URL field is dirty in Link Control 51354
  • Improve search vs direct URL entry detection in Link Control 51011
  • Visually hide the LinkControl initial/results heading 50977
  • Use "Save" instead of "Apply" in Link Control 50964
  • Use checkbox for Open in new tab within Link Control 50961
  • Reinstate Text control outside of settings in Link Control 50957
  • Link Control require user to manually submit any changes 50668
  • Add support for text only labels 47930
  • Add settings "drawer" to Link Control 47328

General

  • Make sure all screenshots are relevant to the latest version
  • Make sure videos, if any, are up to date
  • Add ALT tags for the images
  • Make sure the headings are in sentence case
  • Convert all reusable blocks to a ‘regular block’.
  • Update the changelog at the end of the article

##WHY?
The way the Link Editing feature works is going to change in 6.3 and this is going to affect several articles. It is easier to maintain the updates in one place and link to this page from other articles.

@femkreations femkreations added user documentation (HelpHub) Improvements or additions to end-user documentation [Status] To do Issue marked as Todo medium priority 6.3 Changes in 6.3 release labels Jul 13, 2023
@Leonardus-Nugraha Leonardus-Nugraha added the new document Requests for new page/article. label Jul 25, 2023
@foosantos
Copy link
Member

/assign

@zzap
Copy link
Member

zzap commented Aug 9, 2023

Hey @foosantos, thanks for your interest in this issue! 🍪🍪🍪
If you have any questions, do not hesitate to ask them in our #docs Slack channel.
Enjoy and happy contributing ❤️

@github-actions github-actions bot added [Status] In progress Issue is in progress and removed [Status] To do Issue marked as Todo labels Aug 9, 2023
@foosantos
Copy link
Member

I had the following tasks:

Could someone review it?

cc @femkreations

@anandau
Copy link
Collaborator

anandau commented Sep 22, 2023

I have reviewed all the above-mentioned docs. It looks good to me.

I have one query. Whether such links should open in a new tab?
As a reader, I am still going through the doc and will click on such links only for some additional info. So I think it can be a good idea to open them in a new tab. That is just my thought.

What do you think @femkreations @zzap?

@foosantos
Copy link
Member

@anandau I don't think this is how we generally do on our docs unless I'm missing something here. I guess it could be proposed as a change to the docs.

I also believe it would have accessibility issues — we would need to inform users whenever it opens in a new tab.

@anandau
Copy link
Collaborator

anandau commented Sep 22, 2023

Yes, it is done in the same way throughout all the docs. Even I have done the same in some of the docs that I have updated recently. It is just a thought that came into my mind while reviewing.
But I got your point about accessibility.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.3 Changes in 6.3 release medium priority new document Requests for new page/article. self-assigned [Status] In progress Issue is in progress user documentation (HelpHub) Improvements or additions to end-user documentation
Projects
Status: Needs 1st Review
Development

No branches or pull requests

5 participants