I continue working on Open Web Calendar after I resolved an issue to deprecate Python 3.9. This time, I try to work on another type of issue that I've never done before - optimization of documentation build.
About the issue
The issue is to reduce documentation build time during testing, by introducing a MkDocs configuration file (mkdocs.test.yml) that inherits from the main mkdocs.yml. This test configuration should build only the English documentation plus one well-translated additional language, instead of including the full set of languages as it does now. This test-focused build will be integrated into run-tests.yml using the existing tox workflow.
The work I've done (keep updating)
As I have not handled similar issues before, I don't know how much time I will spend on this issue, but I want to let the maintainer and the community know that I'm working on the issue and show my progress. This is the perfect scenario to create a draft pull request, to allow the community to check my work in progress while preventing accidental merges. I made the draft pull request after pushing the mkdocs.test.yml file, indicating the work done and to be done, as shown in the image below.
The remaining work is to update tox.ini and .github/workflows/run-test.yml for the new documentation build as suggested by the maintainer in the issue. The requirements for the mkdocs.test.yml file was clearly stated in the issue so I could do it quickly, but the update for tox and run-tests.yml were only briefly explained. Given my limited knowledge to tox and GitHub Workflow, I have to do some research on how to change the files. (progress to be updated...)
Lessons learnt (keep updating)
First of all, I have learnt the importance of making your work transparent to the open source community, even if the work is still in progress. This prevent the case of different people working on the same issue redundantly, while allowing others to know the progress and check the work in case things go wrong. (more to be updated...)
Top comments (0)