Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add statistics & figures about features & usage #16

Open
sadielbartholomew opened this issue Aug 25, 2019 · 0 comments
Open

Add statistics & figures about features & usage #16

sadielbartholomew opened this issue Aug 25, 2019 · 0 comments
Labels
enhancement New feature or request

Comments

@sadielbartholomew
Copy link
Collaborator

Towards improving certain sections, notably the Features & Users pages, I think we could promote Cylc by incorporating carefully selected figures relating to these aspects.

I thought this merits its own Issue to e.g. #11 since it may require some discussion as to:

  • which figures are best to include (we don't want to include too many, I think, just highlight the ones which are especially impressive), possibilities being for example the number of:
    • institutions using Cylc, &/or the years they have been in use there;
    • batch systems (directly) supported: 8, according to the docs;
    • diagrams &/or code examples contained in the docs (see example below, & also the final bullet in the opening comment of Include, rather than write in, significant code examples cylc-doc#67 (comment));
    • cylc commands;
    • suite.rc configuration settings.
    • approaches for grouping & consolidating suite configuration (parameters, templating via Jinja2 or EmPy, families): 3
  • illustrative numbers of lines of code required to achieve basic suite setups (which should be small).
  • how we can keep such figures up-to-date. Note:
    • if possible we ideally could extract these figures automatically, but if not we should have a review period to check & update them as appropriate.
    • we could always provide a bound rather than a hard figure, e.g. 'more than 70' / '70 '.

Examples

Other projects quote impressive figures about their projects on their project homepages to good effect. Some examples are captured in screenshots below:

ZeroMQ:

ZMQ_scr

AWS:

aws_scr

Dash:

scr_dash

@sadielbartholomew sadielbartholomew added the enhancement New feature or request label Aug 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant