Regarding project "Refactor and Automate Infusion Documentation"

[Yash Jipkate]

Hi everyone,

I am Yash, and I need some discussion regarding the project "Refactor and
Automating Infusion Documentation" and wanted to get your opinions on it.

   1. The HUGO code would be in a different repository; this would mean
   that the current repo would have to be cleaned of any rendering code, just
   .md and static files would remain. There is a way to clone another repo
   into a repo with the help of a script in the CI job.
   2. The CI should trigger whenever there is a push to main docs repo;
   this can be achieved by broadcasting a repository dispatch event from the
   main docs repo.
   3. The cloning of the repo can be done tag-wise, i.e., instead of
   cloning the whole repo, cloning just a specific tag(s) would be done looped
   over all the available tags.
   4. There are some libraries for indexing content and implementing the
   search functionality like hugo-lunr
   5. The front matter - since it is required to not include it in the
   files of the main docs repo - can be made as layouts. The only needed front
   matter seems to be the title of the page and the GitHub link - both of
   which can be determined with the help of FIle Variables in HUGO.
   6. The file structure would result as follows: All the .md documentation
   files would be having the same organization with their tags at the topmost
   level. In other words, the file structure for the .md files would be
   content -> <tag> -> <files-in-their =-original-structure>. The static files
   would be placed in static/ at the same level as 'content' as required by
   HUGO.
   7. After cloning a tag, its contents would be copied to relevant
   directories, and then the clone would be deleted, and the process would be
   repeated for each tag, thus watching changes in each tag.

These are some of my findings. What are your opinions? Should this be the
way to do it? Or am I missing something that needs to be addressed?

It would be great if I could get some insight into this. Also, it would be
of great help if I get some guidance on how to start since the current docs
repo has no standing issues on the tracker.

Thanks and Regards,
Yash Jipkate
Sophomore Undergraduate,
IIT(BHU) Varanasi
India
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.idrc.ocad.ca/pipermail/fluid-work/attachments/20200225/98b7e366/attachment.html>