Over the next few weeks, we will be completing the migration of ACCESS-NRI documentation sites to a new hosting platform: Read the Docs.
Many of our documentation sites are already hosted on Read the Docs. This work will transition the remaining sites so that all ACCESS-NRI documentation uses a common platform moving forward.
The transition is primarily aimed at improving the maintainability of our documentation and enabling versioned documentation where appropriate. For most users and contributors, the change should be largely invisible, but there are a few things you may notice.
What changes will you see? Not many!
-
Some sites will have versioning, making it easier to access documentation that matches a specific software or model release.
-
Some sites may display advertisements provided through the Read the Docs platform.
-
A small number of documentation URLs will change and will be announced in this thread before they take effect.
-
If you contribute to ACCESS-NRI documentation, you should see little or no change to your existing contribution workflow. Most of the changes associated with this migration affect documentation hosting and maintenance.
Why are we making this change?
-
Easier maintenance of documentation for ACCESS-NRI
-
Support for versioned documentation
Why are there ads?
Read the Docs helps fund its free and open-source documentation hosting service through what it describes as ethical advertising:
-
Relevant to technical, scientific, and software-development audiences
-
Clearly separated from documentation content and non-intrusive
-
Do not track you or sell your data (are hosted by Read the Docs - no third parties)
-
10% of ad space is given to community projects (e.g. open-source projects and events)
For more information, see the Read the Docs documentation on ethical advertising.
Looking ahead
This migration is part of a broader review and revamp of ACCESS-NRI’s web presence.
Over the next year, we will be reviewing our website and documentation sites for usability, navigation, and discoverability. As part of that work, we will re-evaluate the presence of ads on our documentation sites.