Transitioning module information from wiki.mozilla.org to source tree

[Zeid Zabaneh]

Greetings all,

Up until now, Firefox modules were defined in manually edited wiki pages in a format that is difficult to parse and consume by other systems. A side effect of this, and a limitation to how this data can be used, is that data is prone to going out of date and can not be easily integrated into the code review workflow.

We have been working on a new system (mots[1]) which aims to solve this problem by providing a framework for module information to be defined in the source tree within a configuration file. A versatile helper library with the same name has been built to facilitate modifying, validating, and cleaning this file[2], as well as to provide integration bindings that will enable consumption of this information by other systems.

As of Tuesday, October 18th, the wiki pages for Desktop Firefox, Toolkit, Core, and Testing no longer contain module owner and peer information, and this information can now be accessed here: https://firefox-source-docs.mozilla.org/mots/index.html (source code here: https://searchfox.org/mozilla-central/source/mots.yaml).

For more information on how to add, remove, or modify module information, you can access the mots documentation here: https://mots.readthedocs.io/en/latest/#command-line-usage. There are planned improvements to the tool, as well as some existing known issues, however if you want to file any issues related to usability or functionality, you can do so in Conduit::mots at this link: https://bugzilla.mozilla.org/enter_bug.cgi?product=Conduit&component=mots.

Any feedback is appreciated!

Zeid

[1] mots is pronounced “mo” and is spelled with lowercase letters
[2] The mots helper library can be installed from PyPI (https://pypi.org/project/mots)

--
You received this message because you are subscribed to the Google Groups "firef...@mozilla.org" group.
To unsubscribe from this group and stop receiving emails from it, send an email to firefox-dev...@mozilla.org.
To view this discussion on the web visit https://groups.google.com/a/mozilla.org/d/msgid/firefox-dev/CANztLsq%2BU%3Df2msfbUA%3DOLiQDd3YaN8TFpqvBNqKzzXHCWe61Yg%40mail.gmail.com.

[Andrew McCreight]

On Wed, Oct 19, 2022 at 8:33 AM Zeid Zabaneh <ze...@mozilla.com> wrote:

Greetings all,

Up until now, Firefox modules were defined in manually edited wiki pages in a format that is difficult to parse and consume by other systems. A side effect of this, and a limitation to how this data can be used, is that data is prone to going out of date and can not be easily integrated into the code review workflow.

We have been working on a new system (mots[1]) which aims to solve this problem by providing a framework for module information to be defined in the source tree within a configuration file. A versatile helper library with the same name has been built to facilitate modifying, validating, and cleaning this file[2], as well as to provide integration bindings that will enable consumption of this information by other systems.

As of Tuesday, October 18th, the wiki pages for Desktop Firefox, Toolkit, Core, and Testing no longer contain module owner and peer information, and this information can now be accessed here: https://firefox-source-docs.mozilla.org/mots/index.html (source code here: https://searchfox.org/mozilla-central/source/mots.yaml).

For more information on how to add, remove, or modify module information, you can access the mots documentation here: https://mots.readthedocs.io/en/latest/#command-line-usage. There are planned improvements to the tool, as well as some existing known issues, however if you want to file any issues related to usability or functionality, you can do so in Conduit::mots at this link: https://bugzilla.mozilla.org/enter_bug.cgi?product=Conduit&component=mots.

Module owners should be sure to audit the entries for their modules. The imports from the wiki page were done in July, and any changes you may have made to the wiki since then have not been reflected into the mots.yaml file. It would also be good to check for other kinds of errors that might have happened on import, as I noticed a few for modules I'm a peer of. It is also a good excuse to go through and update other bits of data in the module entries (I deleted a few directories that no longer exist for XPCOM, for instance).

Andrew

 

Any feedback is appreciated!

Zeid

[1] mots is pronounced “mo” and is spelled with lowercase letters
[2] The mots helper library can be installed from PyPI (https://pypi.org/project/mots)

--

You received this message because you are subscribed to the Google Groups "dev-pl...@mozilla.org" group.
To unsubscribe from this group and stop receiving emails from it, send an email to dev-platform...@mozilla.org.
To view this discussion on the web visit https://groups.google.com/a/mozilla.org/d/msgid/dev-platform/CANztLsq%2BU%3Df2msfbUA%3DOLiQDd3YaN8TFpqvBNqKzzXHCWe61Yg%40mail.gmail.com.

--
You received this message because you are subscribed to the Google Groups "firef...@mozilla.org" group.
To unsubscribe from this group and stop receiving emails from it, send an email to firefox-dev...@mozilla.org.

To view this discussion on the web visit https://groups.google.com/a/mozilla.org/d/msgid/firefox-dev/CAG3OmdNB5M8drya-hnySR7RnOjWk2%2Bub_KRMY_2kZFqmbbMGFA%40mail.gmail.com.