(Preparing to) move NSS docs off MDN #2669
Comments
|
@chrisdavidmills Decided to be helpful on point 2 - bunch of links fixed on #2960. A good task to cool my brain down on. There are still quite a few broken links showing up. Specifically everything to the project NSPR and also a few archived docs like https://developer.mozilla.org/en-US/docs/Archive/Security/Introduction_to_SSL FYI, not an automatic task :-( |
Yeah, unfortunately not, by the looks of things. I'm assuming in doing this work you are just working through the folder structure alphabetically? Do you think you can create a simple list in here that shows which directories have had their broken URLs fixed so far, and by what PR? Just so others that might work on it can easily see at a glance what else there is to be done? |
|
Possibly, but if you can tell me how to fix the NSPR links and confirm that we can ignore the archive links that would be a smaller task. This pretty much fixes everything else that can be fixed due to links being "accidentally broken" |
|
Thanks @hamishwillee , that's super helpful. I will see if I can find some time to do a few of these. Also feel free to to keep picking bits off ;-) |
|
Great. Will do. Quite a few of these might also be fixed by creating one or two little docs - e.g. aCK_SESSION_HANDLE is clearly a copy of https://www.cryptsoft.com/pkcs11doc/v100/pkcs11__all_8h.html#aCK_SESSION_HANDLE |
|
Yet more done in #3290. This is what is left. I think that I'm at the end of what I can do Broken Links
/en-US/docs/Mozilla/Developer_guide/Build_Instructions/CVS_Tags line 106:198
INVALID (archived): /en-US/docs/Archive/Security/Introduction_to_Public-Key_Cryptography line 30:19 /en-US/NSC_CancelFunction line 27:19 /en-US/NSC_CloseAllSessions line 27:109 /en-US/NSC_DigestInit line 28:19 /en-US/NSC_DigestFinal line 30:105 /en-US/NSC_DigestInit line 28:19 /en-US/NSC_SetAttributeValue 👀 line 32:19 /en-US/NSS/CERTIssuerAndSN line 19:260 |
|
@escattone a friendly ping on this one Ryan. @hamishwillee has done a whole bunch of work to fix broken links in these docs, so the next stage is to scrape the rendered NSS docs off the site into a "pure" HTML form that the NSS team can use. Also pinging @beurdouche for an update as to the latest progress on this. |
|
Thanks a lot, this is very helpful! :) Regarding the links, if you can point the Non-FIPS mode to the page you suggested, it would be great I think that there is no need to worry about the rest of the links. |
|
Hi @beurdouche , the link you refer to will be fixed by #3513. I am not promising on my life that all links are fixed - but certainly the main docs have all been gone through and any flaws shown by the automatic tooling have been fixed up. The ones marked as Invalid above show up as broken if you build locally but work on the main site (i.e. the scaped version will work) |
|
Hi @beurdouche ! It looks like we've finished doing link fixes on this content, so it is ready to scrape and get into a rendered out HTML format for you folks to use. In which case, the next stage is to create a scraper to scrape the content off of MDN. We will probably create a simple script to do this, and then hand it over to you folks so you can do the conversion and tweak it as needed. My question here is — what do you want the HTML to look like, exactly? Do you need a full page for each, including doctype, simple document head, plus body, or do you just need the body content for each? Or something else? |
|
Hi @chrisdavidmills, thanks for all the work so far! I can answer this for @beurdouche. Just the content would be the best for us. We basically just need the files the way they are on github right now but with the macros expanded. |
Do you want them with the YAML front matter included? |
|
Good question. Currently the conversion script uses the YAML to get the title but I am guessing that the scraped HTML will have the titles in it? If that is the case then we don't need the YAML. |
That's correct — the scraped page would include the So assuming that you don't have any usage for the tags, slug, etc, then that sounds ok. My esteemed colleague @escattone and his team would be helping with the actual scraping code here, so I'll pass this over to him. Ryan, the one thought I still have here is that we'd probably need to scrape them and provide the scraped content in a folder structure that matches the existing folder structure in the source, to help @dergoegge put them in the same kind of structure that they are currently on MDN, in their new home. This would in turn help us to put redirects to the new locations in place much more easily. Sound reasonable? I was thinking you could start by scraping a few docs, and sharing them with Niklas to check if tey are ok for his purposes. |
|
@chrisdavidmills All sounds reasonable! Let me get cracking on the scraper this week, share an example with @dergoegge, and we can iterate from there. |
|
@escattone thanks, much appreciated. |
|
@dergoegge @beurdouche I created an initial set of "distilled" NSS docs in https://github.com/mdn/nss-docs. By "distilled", I mean I extracted |
|
@escattone Could you change it so the files only contain the inner html of |
|
@dergoegge I've updated https://github.com/mdn/nss-docs to reflect your requested change. Hope that works for you. |
|
It looks looks like the work to add the docs to the source tree is at https://bugzilla.mozilla.org/show_bug.cgi?id=1709817 |
Rumyra
added
needs triage
Rumyra
removed
the
needs triage
|
Thanks for the update @mathewhodson. |
|
The NSS files have been deleted from MDN. Any reason we can't close this? Speak now, or I'll close next time I come around. I appreciate there may be more "work" being done to publish by the NSS team, but that is out of scope for the people working on content,. |
|
@hamishwillee 👍 I agree. I think we can close this. |
|
@Rumyra @schalkneethling I am reopening because this has still not been removed and Ryan has left the building. The plan here was to delete the NSS tree, which is broken and which the NSS team were taking over. We did so in #8215 but it was reverted because they were not ready. Ryan was liasing to find a time but not as far as I could see actually pushing. I would like to propose deletion of this tree within the month "come what may" as they've have more than enough time - we can put the source in archive if desired. Is there someone we can notify in that team? If so, who? EDIT: Note, closing. Seems this came up 4 days ago and is being addressed in #12471 |
github-actions
bot
added
the
needs triage
We need to help the Mozilla NSS team move their documentation off MDN. To be clear, we are talking about everything underneath https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS.
The goal is to get to the stage where all of the documentation under /NSS is available as static, standalone HTML files that are free from KumaScript macros, have links fixed up as much as is possible, and can be used in the new destination (which we are hoping will be the Firefox source docs Sphinx instance)
The tasks required are:
/en-US/docs/Mozilla/Projects/NSS/xxx>/new/relative/path/xxx/en-US/docs/Mozilla/xxx>https://developer.mozilla.org/en-US/docs/Mozilla/xxxThe text was updated successfully, but these errors were encountered: