daisy / epubcheck-website Goto Github PK

Pending code refactor

step by step guided tutorial on how to run EPUBCheck

Under subsection "Source code"

how to contribute to the localization of EPUBCheck

... to whatever the EPUBCheck team would prefer. At the moment, several of them are prefixed with DOCSSITE_ as they relate to the versioned documentation feature. Not sure if they prefer verbosity or terseness.

Under "messages documentation" subsection.

Generated automatically from the parsing done in #5

Under subsection "Development workflow"

List and short descriptions of interesting third party tools and apps based on EPUBCheck

• Update direct link download in user/cli.md (https://daisy.github.io/epubcheck-website/download-latest/)
• Check for broken links

Under subsection "CLI Documentation"

Under subsection "Source code"

I think it might be useful: some users who are not used to the command line might have problems and not know who to ask. We could suggest asking #eprdctn or opening an issue on GitHub.

Under subsection "Contributors guide"

There was an experiment to add TRAVIS_TAG to versions.json, so that the versions would not have to be tracked manually.

What this experiment didn't cover was having Travis recommit this file to the repo after the prebuild process changes it.

Ask the EPUBCheck team what they prefer - to configure it manually or have CI in charge of modifying a file and committing changes to the main repo.

Under subsection "Development workflow"

I've been working on the installation guide and would like to do a push, but git tells me I don't have the necessary permits.

Under subsection "Development workflow"

Under subsection "Source code"

Under subsection "CLI Documentation"

Under subsection "Development workflow"

On my side I would have written the part on the installation guide (issue #7 ), but what process do we use to consider it closed?

Do I ask you for validation? Or do I close it myself and then we'll see it all at the end?

Under subsection "Contributor's Guide"

Several pages are just stubs

Under subsection "Contributor's guide"

Right now, the GitHub release data is retrieved from the GitHub API each time the site is built. This quickly runs into rate limits. We could possibly cache the information for use when the API fails.

Hi,
is the website already online? In case what is the URL?

Thanks,
Gregorio

Under subsection "Development workflow"

I think it would be really useful to have a direct link, like epubchek.org/download-latest, that points to the download file of the latest version of EPUBcheck (right now it would be https://github.com/w3c/epubcheck/releases/download/v4.2.2/epubcheck-4.2.2.zip ).

This would simplify part of the explanation for the installation (issue #7 )