1317260 - Updating Mozilla CA Certificate Policy

Status: RESOLVED FIXED

(www.mozilla.org :: Pages & Content, defect)

Description

[Gervase Markham [:gerv]]

Hi,

We are now maintaining the Mozilla CA Certificate Policy here:
https://github.com/mozilla/pkipolicy/blob/master/rootstore/policy.md
and are about to release a new version, which will need to live at:
https://www.mozilla.org/en-US/about/governance/policies/security-group/certs/policy/

The sub-pages at:
https://www.mozilla.org/en-US/about/governance/policies/security-group/certs/policy/inclusion/
https://www.mozilla.org/en-US/about/governance/policies/security-group/certs/policy/maintenance/
https://www.mozilla.org/en-US/about/governance/policies/security-group/certs/policy/enforcement/
should all change to redirect to that higher-level page, because the policy is now a single page.

At the moment, the content rendered at:
https://www.mozilla.org/en-US/about/governance/policies/security-group/certs/policy/
lives in the bedrock repo here:
https://github.com/mozilla/bedrock/blob/master/bedrock/mozorg/templates/mozorg/about/governance/policies/security/certs/index.html

This content is marked up to make it possible to translate it on a string-by-string or paragraph-by-paragraph basis. 

Is it possible to tell if anyone has actually done that - i.e. bothered to translate this policy?

There will be more versions of this policy coming in the future. We would love to have a simple process for publishing new versions which might be to take the Markdown version, run it through pandoc to convert to simple HTML, and then copy and paste it into the above file. However, the l10n markup makes this complicated. If we need to keep the ability to localise it, are there alternate, whole-file l10n methods which can be used for this content? 

If the team could advise on the best way to go about this, that would be great.

Gerv

Comment 1

[Jennifer Bertsch [:jbertsch]]

(In reply to Gervase Markham [:gerv] from comment #0)
> Hi,
> 
> We are now maintaining the Mozilla CA Certificate Policy here:
> https://github.com/mozilla/pkipolicy/blob/master/rootstore/policy.md
> and are about to release a new version, which will need to live at:
> https://www.mozilla.org/en-US/about/governance/policies/security-group/certs/
> policy/
> 
> The sub-pages at:
> https://www.mozilla.org/en-US/about/governance/policies/security-group/certs/
> policy/inclusion/
> https://www.mozilla.org/en-US/about/governance/policies/security-group/certs/
> policy/maintenance/
> https://www.mozilla.org/en-US/about/governance/policies/security-group/certs/
> policy/enforcement/
> should all change to redirect to that higher-level page, because the policy
> is now a single page.
> 
> At the moment, the content rendered at:
> https://www.mozilla.org/en-US/about/governance/policies/security-group/certs/
> policy/
> lives in the bedrock repo here:
> https://github.com/mozilla/bedrock/blob/master/bedrock/mozorg/templates/
> mozorg/about/governance/policies/security/certs/index.html
> 
> This content is marked up to make it possible to translate it on a
> string-by-string or paragraph-by-paragraph basis. 
> 
> Is it possible to tell if anyone has actually done that - i.e. bothered to
> translate this policy?
> 
> There will be more versions of this policy coming in the future. We would
> love to have a simple process for publishing new versions which might be to
> take the Markdown version, run it through pandoc to convert to simple HTML,
> and then copy and paste it into the above file. However, the l10n markup
> makes this complicated. If we need to keep the ability to localise it, are
> there alternate, whole-file l10n methods which can be used for this content? 
> 
> If the team could advise on the best way to go about this, that would be
> great.
> 
> Gerv

Hi Gerv-

The content is not currently localized.  Is localization a requirement?  Or can we say this is en-US only?

What is your timeline for this project?

We've separately been thinking about simpler ways to publish content on the www.mozilla.org website.

Adding pmac and Ben Sternthal as NI as an FYI.  No action required yet.

Thanks,
Jen

Comment 2

[Gervase Markham [:gerv]]

No need for localization; but of course the en-US version needs displaying to everyone.

Timeline: ASAP, please - certainly before Hawaii. This is pretty much ready and we'd like to ship it.

Gerv

Comment 3

[Paul [:pmac] McLanahan]

Gerv,

Apologies for the delay. I can definitely get the current version updated quickly (this week) in production. It will take a bit more time to get it automatically updating from the markdown in your repo, bu that is also quite doable, especially if l10n isn't a concern.

When we do get auto-updating working, will we need to update only when requested, or will the version of the document in the "master" branch of the repo always be the one the should be published on the site? For example, the legal-docs repo[0] is only updated on request, whereas the security advisories[1] one is updated on every push to the master branch.

[0] https://github.com/mozilla/legal-docs
[1] https://github.com/mozilla/foundation-security-advisories

Comment 4

[Gervase Markham [:gerv]]

pmac: absolutely update only on request, and it will be to a specific branch. The master branch is development, not official policy. So the version we are shipping here is 2.3, from the 2.3 branch. I see I didn't make this clear above; my apologies. The version to ship is this one:
https://github.com/mozilla/pkipolicy/blob/2.3/rootstore/policy.md

Thanks! If you could do a one-off ship this week, that would be great - along with the redirects and consolidation etc. I expect version 2.4 to appear in Q1.

Given that we want manual updates to a specific branch, if you want to simply set it up so it requires a script or a few commands (e.g. a git pull and a pandoc), rather than auto-update, that's fine. I don't want you to spend hours automating a task which might happen twice a year.

Gerv

Comment 5

[Paul [:pmac] McLanahan]

Attachment: Link to Github pull-request: https://github.com/mozilla/bedrock/pull/4522

Pull request to update the document, delete the old sub-pages, add redirects, and document the process for future updates of the file.

Comment 6

[Paul [:pmac] McLanahan]

(In reply to Gervase Markham [:gerv] from comment #4)
> pmac: absolutely update only on request, and it will be to a specific
> branch. The master branch is development, not official policy. So the
> version we are shipping here is 2.3, from the 2.3 branch. I see I didn't
> make this clear above; my apologies. The version to ship is this one:
> https://github.com/mozilla/pkipolicy/blob/2.3/rootstore/policy.md

Great. Updated my PR with this file instead of the one in master.

> Thanks! If you could do a one-off ship this week, that would be great -
> along with the redirects and consolidation etc. I expect version 2.4 to
> appear in Q1.

We should be able to have it in prod by end of week no problem.

> Given that we want manual updates to a specific branch, if you want to
> simply set it up so it requires a script or a few commands (e.g. a git pull
> and a pandoc), rather than auto-update, that's fine. I don't want you to
> spend hours automating a task which might happen twice a year.

That's perfect. I've documented in the template itself some quick instructions for updating the file. It could be even more simple, but this should work well and we can always improve things should we need to. Just file a bug for us whenever you're ready for an update to the document.

Comment 7

[[github robot]]

Commits pushed to master at https://github.com/mozilla/bedrock

https://github.com/mozilla/bedrock/commit/a09f1cd119f77f3a0d88a02993e233e911de9cb5
Bug 1317260: Update CA Cert Policy document

This updates the file based on the markdown from the
repo and documents updating it in future in the template
itself. It also deletes the sub pages, and adds
tests and redirects for the same.

https://github.com/mozilla/bedrock/commit/526d9ce48ba86471e77abccad16a4d4b6f57ec68
Merge pull request #4522 from pmac/update-certs-policy-1317260

Bug 1317260: Update CA Cert Policy document

Comment 8

[Paul [:pmac] McLanahan]

I think we can call this done since we've decided not to implement any auto-updating and will instead open new bugs when a new version is ready for publication.

Thanks all.