Add rogtemplate features

[dieghernan]

Following https://github.com/orgs/rOpenGov/projects/2 and https://github.com/orgs/rOpenGov/teams/core/discussions/2

Also, site should be deployed from gh-pages branch

[antagomir]

Hi - what is the added advantage for deploying the homepage through gh-pages branch? This can be done but it is an extra task to do, so I would be curious about the benefits.

We did use gh-pages at some point, then moved to docs/ folder approach for some repositories due to some issues that I have forgot. Both approaches are possible.

I am ok to moving pages to gh-pages branch if there are advantages and someone has the time to implement the necessary changes.

[dieghernan]

Hi @antagomir , good points.

The main advantages that I can foresee are:

• It can be easily deployed via GHA , as you have already seen. I can configure also a GHA for deployment on docs/ folder but this has some disadvantages, mostly:
  • Cluttering you git history with GHA commits
  • The user MUST rebase/merge the branch after deployment, as the commit is produced only on the GitHub repo. I had bad experiences on this.
• The triggers can be set to perform deployment only on specific events (new release, etc.). Also, pkgdown provides an option to detect wheter the site must be deployed on https://ropengov.github.io// or https://ropengov.github.io//dev via the development mode auto. See latest release of pkgdown https://pkgdown.r-lib.org/ vs dev version https://pkgdown.r-lib.org/dev.

On the other hand, deployment doesn't need to be done on GHA, the user could do it locally on docs/ and push the commits. This is fine for me too but has two drawbacks:

• rogtemplate needs to be installed on the local machine, see https://github.com/rOpenGov/rogtemplate#option-b-deploy-installing-rogtemplate. Note that probably it would be neccesary to reinstall rogtemplate every time as it is an experimental package, this doesn't happen on GHA as it is reinstalled on each trigger by default.
• Need to manually update the docs. As I said, a combination of GHA + development auto on pkgdown saves you time on this, deploying only non-dev versions on the main root of the site and dev versions on root/dev.

Regards

[antagomir]

Ok sounds good to me!

We did use CI (Travis) earlier with gh-pages and there were some issues but I do not think it was anything major. We can proceed to gh-branches. If you can implement the changes for active repositories this would be awesome.

[dieghernan]

On it! See the current status here;

https://github.com/orgs/rOpenGov/projects/2

My current approach is:

• Repos that hasn't been updated in years: I implemented the changes
• Rest of repos: PR and request review of maintainers,

[antagomir]

Ok for old non-up-to-date repos; some of these are still in use but we should also check again what should be archived.