developer-portal/tools

Tools and scripts for Fedora Developer Portal.

Tools and scripts for Fedora Developer Portal.

For building website, and website maintenance.

Expects the following structure:

.
├── developer.fedoraproject.org
├── tools
└── website

Basic usage

Check the usage for any script with:

$ tools/common.sh -h

Building website

Latest way to build the website is using the container:

$ tools/container.sh

Commit with generated website is created in developer.fedoraproject.org directory.

Changes overview for ML purposes

After you've done building the website, and reviewing the commit, you can use email.sh or links.sh script to get the links list of changed files.

The email.sh script uses developer.fedoraproject.org latest pushed commit on origin/release, or origin/master branch with -s, respectively. This output is more detailed (includes Markdown files changes), but needs the changes pushed to origin remote.

Example:

$ tools/email.sh -s

---

Alternatively, you can use links.sh, which uses content repository to get list of changed files in comparison to specified commit. You need to specify the latest released content commit (ideally). It uses current state (actual commit) of content repository to diff to. The purpose of this script is to work around large commits, which change all files.

Example:

$ tools/links.sh -s de3274559907af5e25377717be58e2305801986c

---

For both, there's option -s to get changes for staging website/repository.

tools's Issues

Move `get_authors` script to standalone jekyll plugin

It could be generator, or a hook:
https://jekyllrb.com/docs/plugins/#generators
https://jekyllrb.com/docs/plugins/#hooks

Adds authors seemlessly during build. (Will probably need #14.)

Obfuscate authors email address

See developer-portal/content#262.

This requires syntax change from Markdown format to a different one.

@jackorp, PTAL.

Fix tests for `get_authors` script

While addressing issues mentioned in PR #2:

• Do not use --global
• Use helper function for git ... commands.
• Add mailto: format.

`get_authors` script should check for preexisting entries

Changes can be preexisting in a file on a subsequent get_authors.rb run. Script should not add second Authors list.

Note: this is not a hard requirement. (Needs investigating whether is needed for #15.)