Skip to content

Add Wikimedia Foundation to adoption.rst #96

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Wikimedia Foundation to adoption.rst #96

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions adoption.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ bodies of documentation. In some cases the adoption remains partial or is still
* `StrongLoop/LoopBack <https://loopback.io/doc/en/lb4>`_ by IBM
* `TerminusDB <https://terminusdb.com/docs/terminusdb/#/>`_
* Tesla Motors (internal)
* `Wikimedia Foundation <https://www.wikimedia.org/>`_, technical documentation for Wikimedia projects and open-source software
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you mean to link to https://www.mediawiki.org? I don't see any technical documentation at https://www.wikimedia.org, let alone docs conforming to the Diátaxis framework.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because the technical documentation for Wikimedia projects is scattered across many wikis and other platforms, it seemed most succinct to link to that page because it links to all the many projects. I guess I also thought the goal was to link to the organization's website, not a specific set of documentation. That said, maybe a link to developer.wikimedia.org would be better?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

technical documentation for Wikimedia projects is scattered across many wikis and other platforms

Right, it's quite scattered, but I also think much of it doesn't conform to the Diátaxis framework, so it probably would be helpful to highlight specific Wikimedia docs that do adhere to it. Are there many that do? 🤔

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are working on it! Diátaxis is the framework we're using for all our doc work and education about tech writing: https://www.mediawiki.org/wiki/Documentation/Toolkit.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's great to hear! So I probably would suggest linking to the toolkit page in this PR (or better yet, the "Templates for common document types" section directly), unless there is a particular instance of Wikimedia docs already structured that way that you think would be worth highlighting. Otherwise, just linking to wikimedia.org seems like it might confuse people who actually follow the link expecting to see usage of the framework there.

* `WebAccess/DMP <https://docs.wadmp.com>`_
* `websockets <https://websockets.readthedocs.io>`_
* `Wechaty <https://wechaty.js.org/docs/>`_: A Conversational RPA SDK for Chatbot Makers
Expand Down