1485193 - Link-ify policies documentation to the online docs

Status: VERIFIED FIXED

(Firefox :: Enterprise Policies, enhancement, P2)

Description

[:Felipe Gomes (needinfo for replies!)]

The policies have a built-in short description that is displayed in the Documentation tab of about:policies, but the official online documentation at [1] has more details and examples for each policy.

We should link-ify each policy to the online docs.

I'm not sure if the entire policy name should be a link (and then we need to find a way to expand the inline schema), or if there should be another icon (like an outbound icon) to link-ify

[1] https://github.com/mozilla/policy-templates/blob/master/README.md

Comment 1

[Bram Pitoyo [:bram]]

It makes sense for the entire policy name to be a link, as shown in this example:

https://codesandbox.io/s/qvv0j7lk2j?module=App.js

Including the “Open in New” icon makes sense logically, but showing the same icon to the right of every policy would be too much.

And if we choose to store schema inside each row, that fact should be communicated in a more obvious way. For example, by using a downward arrow:

https://codepen.io/team/carbon/full/gXGabM/

Thoughts?

Comment 2

[:Felipe Gomes (needinfo for replies!)]

Yeah, sounds good. That's the direction I was thinking of too.

Comment 3

[u626306]

Hello Kanika, are you still working on this bug?

Comment 4

[daft.goon]

Hi! Im on Firefox 66 and I think the schema is showing in an acceptable manner i.e. you click on a row to toggle between showing or hiding the schema. Is this an acceptable behavior?

Comment 5

[Mike Kaply [:mkaply]]

Yes, that's an acceptable behavior, but we'd also like to update the policy templates docs and link directly to there as well.

Comment 6

[daft.goon]

So, is all that's left to do currently is to linkify each of the policies to their online official documentations?

Comment 7

[Mike Kaply [:mkaply]]

So, is all that's left to do currently is to linkify each of the policies to their online official documentations?

Yes, but first we need to cleanup the official documentation. It's being worked on,

Comment 8

[daft.goon]

Ah! Okay, that's excellent.

Is there a bug we can follow for that?

Comment 9

[Mike Kaply [:mkaply]]

Is there a bug we can follow for that?

No bug, it's just general Github work that's going on. If anyone wants to help, I can provide info.

Comment 10

[Brandon_Davison]

Hey, I'm new to the community and was looking to help out. Would I be able to take this on as a first issue?

Comment 11

[Mike Kaply [:mkaply]]

Yes, the documentation is now cleaned up and available here:

https://github.com/mozilla/policy-templates/blob/master/README.md

and can be linked to.

Comment 12

[Jayati Shrivastava]

Hello! May I work on this?

Comment 13

[Jayati Shrivastava]

Attachment: Bug 1485193 - Link with documentation in about:policies. r=Felipe

Comment 14

[Mike Kaply [:mkaply]]

Actually, I'll own this. I'll take a look.

Comment 15

[Jayati Shrivastava]

Thanks a lot!

Comment 16

[Mike Kaply [:mkaply]]

Jayati: I made one small request in phabricator. Thanks for the patch!

Comment 17

[Jayati Shrivastava]

Hi Mike! I don't see any comment on phabricator. What change exactly do i need to make?
Thanks for reviewing :)

Comment 18

[Jayati Shrivastava]

Has the documentation for the two left oug policies been added?

Comment 19

[Mike Kaply [:mkaply]]

Weird. My request didn't make it. I just added it. I just want it to open in a new tab (not the same tab).

As far as the two missing policies, no documentation hasn't been added. things will always be a little out of sync.

Comment 20

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/3c8e09333531
Link with documentation in about:policies. r=mkaply

Comment 21

[Noemi Erli[:noemi_erli]]

https://hg.mozilla.org/mozilla-central/rev/3c8e09333531

Comment 22

[Vlad Lucaci, Thunderbird QA (:vlucaci)]

Hello,

Confirming this issue as verified fixed using Windows 10x64, Ubuntu 18.04 and macOS 10.15.5. Verified on 77.0(ID:20200525134724) and 78.0a1(ID:20200526213752).
Policies from the documentation tab are now link-able .