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.

Sign up for GitHub

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

Jump to bottom

Updates to Readme #222

Merged
merged 31 commits into from
Oct 28, 2024
Merged

Updates to Readme #222

Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
42bb695
Update to be linked to the latest tag.
vsmalladi Oct 24, 2024
a0da756
Fix repo.
vsmalladi Oct 24, 2024
93b1e3a
Add back build and spec badges.
vsmalladi Oct 24, 2024
0c05b27
Check with develop.
vsmalladi Oct 24, 2024
d04eca1
Testing ci badge.
vsmalladi Oct 24, 2024
6288dc4
Testing ci badge.
vsmalladi Oct 24, 2024
c4f8d98
check validtor.
vsmalladi Oct 24, 2024
244a8b8
Make a table and visualize all on the status for both master and deve…
vsmalladi Oct 24, 2024
4bf02c6
Change the develop branch name.
vsmalladi Oct 24, 2024
f6495ef
Reword description.
vsmalladi Oct 24, 2024
d9ebe9c
Fix formating and full stops.
vsmalladi Oct 24, 2024
c02bcb9
Add rewording.
vsmalladi Oct 24, 2024
a248cde
Update JSON.
vsmalladi Oct 24, 2024
b287476
Remove Possible future enhancemnts section.
vsmalladi Oct 24, 2024
7f253a0
Add Governance.
vsmalladi Oct 24, 2024
9b19cf7
Add in license.
vsmalladi Oct 24, 2024
8614de7
Fix badges.
vsmalladi Oct 24, 2024
07cbe93
Simplify build.
vsmalladi Oct 28, 2024
aab9eba
Build in PR.
vsmalladi Oct 28, 2024
a55038c
Change the plugin to be used so doesnt require secrets.
vsmalladi Oct 28, 2024
ab2f679
Fix security.
vsmalladi Oct 28, 2024
7e0f90c
Fix spelling error.
vsmalladi Oct 28, 2024
15c3088
update for security.
vsmalladi Oct 28, 2024
31dbd36
Update links.
vsmalladi Oct 28, 2024
6834190
Fix some wording.
vsmalladi Oct 28, 2024
3d1733b
Fix build.
vsmalladi Oct 28, 2024
6209a56
Fix build.
vsmalladi Oct 28, 2024
fc905dd
Fix build.
vsmalladi Oct 28, 2024
e482eac
Fix build syntax.
vsmalladi Oct 28, 2024
04550ed
Add in push.
vsmalladi Oct 28, 2024
4592b2a
Fix voting.
vsmalladi Oct 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ Suggested changes to this schema can be initiated as [**Issues**](https://github

Even those with write access to the main repository should in general create pull request branches within their own forks. This way when the main repository is forked again, the new fork is created with a minimum of extraneous volatile branches.

> To facilitate review of external pull requests, users are encouraged to activate [**Travis CI**](https://travis-ci.org/) to monitor the build status (documentation, Swagger UI) of their fork. By following the documentation for [deployment to GitHub Pages](https://docs.travis-ci.com/user/deployment/pages/) and adding a `$GITHUB_TOKEN` environment variable to their repo configuration, pushes to the forked repo should be viewable relative to `https://[user-or-org].github.io/workflow-execution-service-schemas/preview/<branch>/`:

> To facilitate the review of external pull requests, users are encouraged to activate [**GitHub Actions**](https://github.com/features/actions) to monitor the build status (documentation, Swagger UI) of their fork. By following the documentation for [deployment to GitHub Pages](https://docs.github.com/en/actions/publishing-packages/deploying-to-github-pages) and adding a `$GITHUB_TOKEN` environment variable to their repository configuration, pushes to the forked repository will be viewable at `https://[user-or-org].github.io/workflow-execution-service-schemas/preview/<branch>/`:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would actually be good if you did that so that we could see how the built docs look like with this PR, @vsmalladi ;-)



This version replaces references to Travis CI with GitHub Actions while maintaining the original meaning and intent.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need this? Travis hasn't been in use for a long time, so I don't think anyone will complain about this info changing without this disclaimer.

If you wanna keep it, it probably makes sense to place it as a comment/quote (with >) below the links that follow the colon from the previous statment.


+ https://[user-or-org].github.io/task-execution-schemas/preview/\<branch\>/docs/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are the Swagger links still up to date, actually?

+ https://[user-or-org].github.io/task-execution-schemas/preview/\<branch\>/swagger-ui/
Expand All @@ -32,3 +36,5 @@ Changes for the release are to be approved by 2 TES specification leads.
### post TES v1.0.0 Voting Procedure
The post v1.0.0 voting group include stakeholders, such as server and client implementors.
The membership of this group will be established as part of the v1.0.0 release.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably actually do this and check with the Cloud WS to make sure it's in line with GA4GH regulations. For example, I think GA4GH DPs might need to retain voting rights.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, I think we can remove the pre-TES v1.0.0 stuff, because we're already passed that. And then we can remove the explicit "post" as well, and can just name the section "Voting Procedure".

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Finally, we might want to move the entire section to GOVERNANCE.md and only keep the reference here (because, as it is, this very important info is now missing from GOVERNANCE.md).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix this too


For more information please see the [Governance](GOVERNANCE.md) documentation.
12 changes: 12 additions & 0 deletions GOVERNANCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
TES Governance and Process
==============================

The Task Execution Service (TES) operates under a community-driven development model, where advancements to the specification occur exclusively through community contributions. The governance is steered by a core team of API champions that fosters collaboration and consensus among contributors. This team is tasked with overseeing the design and development processes, setting priorities, managing the release schedule, and making decisions in instances where consensus cannot be reached.

Current API Champions are:

| Name | Organization | github |
|:-------------------|:-------------|:------------------
| Kyle Ellrot | oregon health and science university | [kellrott](https://github.com/kellrott) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe capitalize Oregon Health and Science University?

Might also be good to add links, e.g., https://www.ohsu.edu/

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, at second thought: Perhaps we should replace the "API Champions" with "Product leads" and link to the current product leads at https://www.ga4gh.org/product/task-execution-service-tes/

That way, we don't have to update this file when leads change (which we might forget).

And for getting in contact, we could put the TES email address I think we have (the mailing list).

| Venkat Malladi | Microsoft | [vsmalladi](https://github.com/vsmalladi) |
| Alex Kanitz | ELIXIR | [uniqueg](https://github.com/uniqueg) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you wanna keep this table, please replace ELIXIR with "Swiss Institute of Bioinformatics / ELIXIR Switzerland" and use this URL: https://www.sib.swiss/

Loading
Loading