Compare: https://web.archive.org/web/20200113175409/https://developer...
To: https://github.com/mdn/content/blob/main/files/en-us/web/sec...
Where has all the content gone? And of course there's no history anymore due to how the content has been migrated.
Btw: now you need to clone the entire repository and run a dev server just to edit and preview a single page (let’s not get into super involved ways to clone only part of a git repo). You can avoid cloning by editing with GitHub’s web editor, but you can’t preview that way.
They could've cut it down to e.g. the last n changes to a page if this was a concern.
Honestly the whole migration feels like it has happened before things had been properly thought through. There are pages lying around with {{IncludeSubnav{"")}} directives in the text that don't render properly - and they put this into production.
Isn't your entire article here? The history is there...
Also, at the footer of every document is a link to `$0/contributors.txt`. Your attribution is there: https://developer.mozilla.org/en-US/docs/Web/Security/Certif...
There will be a record of every contributor who submitted a revision to the non-archived content in all locales.
Anecdotally, for the project where I contribute most... the issue about fewer contributors is real. But you do still get contributors, and PR-workflow makes other aspects easier (like broad clean-ups/reorgs/scheduling/versioning). For contributors who come, you also get the opportunity to socialize/engage them during review. Overall, there are drawbacks/risks, but I'd say it was a net-improvement (wrt quality/clarity of the final docs).
Maybe look at it this way: Both workflows provide a way to organize open/community docs. Both workflows have positive role-models. In both, you need capacity+interest for editing, for socialization, etc. If you tend to these, you can do good. But if there's neglect... then that's where you'll see the starkest differences:
* In wiki-workflow, the likely symptoms of neglect are draft-quality content, bad prose, quirky TOC, drive-by edits that are out-of-place, etc.
* In PR-workflow, the likely symptoms of neglect are slow review/feedback, older content, would-be contributors who can't assimilate to the workflow, etc.
Lets be real: internet points in my github profile contribution heatmap
Kidding aside tho, as a first-time contributor back then the non-markdown editor was clunky for me, the spaces the highlights were just un-natty. You're right about the non-instantaneous fix visibility tho, but for extra QA maybe it's a fair trade-off.
Ideally, you want to cater to both the CLI centric workflows of developers/build-systems and the WebUI centric workflows of everyone else (the old system). The Mozilla blog posts mention the JAMStack so I'm guessing that the intent was to port the server-side Django apps/editors to a browser-side framework like React or one of its alternatives.
If the design and implementation of the new platform was perfectly executed then only the new functionality would be apparent; both systems are essentially "wiki-based". Platform transitions are rarely seamless as your lost content/metadata clearly shows.
We are currently doing the same thing at Our World in Data and discussing this exactly so would be great to learn more about the design decisions.
Yeah, I really agree with this. Having built a website which relied on people submitting PRs to add their content on GitHub - I wouldn't do it again. It's a lot of friction for both the maintainers and people contributing.
I don't know if I hit an exception, but I added a small change (a single clarifying example) to the RegEx page, which was listed on the dev environment's history for ages before actually becoming active.
Also keep in mind that, given MDN's target audience, especially the target contributors, GitHub is less of a barrier than it would be for other platforms.
But yes, of course it'd still be good to keep an eye on the contribution statistics to validate those assumptions.
This is not to say there aren't advantages to the git-based workflow and it might be a valid choice for a technical audience like this, but to claim it as "huge advantage in terms of contribution workflow" seems questionable.
2. GitHub and GitLab are a lot better nowadays at allowing you to edit markdown docs via the web and preview the results in a few clicks. Not quite as frictionless as 1 click, however if you are an editor and are constantly bombarded by spam, probably saves a lot of time as you know the person who is making the change and they are forced to add an explanation via commit message.
2. Yeah, it's really really convenient to submit a quick PR entirely in the GitHub Web UI. But I admit, we have some work to do make the previewing experience a bit better.
I'm only a sample of 1, but I once tried to edit a page and just couldn't find out how to do it. So I'm not sure their change will be any worse.
I've said it before, but I think this move was a mistake. They've thrown away the benefits of a incredible wiki-based platform (where changes were pretty much instantaneous and any of us could easily make a difference to the docs!), the (actually pretty decent) WYSIWYG editor and an overall frictionless editing experience and replaced it with what, some (not even Markdown) document files in a GitHub repository. I honestly believe this will dissuade people from making small, quick fixes and ultimately drive away contributors.
When I last brought this up, I was told that there were a number of contributors put off by the wiki-based nature of the previous iteration and they will now be excited to be able to contribute using Git.
I'd honestly be interested to hear from any of these people. Given you could seamlessly login with your GitHub account, easily author your documentation and one-click preview your changes, what exactly are you gaining from having the editor gone and now requiring a local docs environment to do all of the preview/edit/commit steps manually?