Skip to content

Commit f36cf5a

Browse files
mbaudismbaudis
committed
docs ehancements
- removed old branch info - added 2 releases to "changes" - fixed some links on Progenetix/bycon page
1 parent 4d9e306 commit f36cf5a

3 files changed

Lines changed: 20 additions & 118 deletions

File tree

‎docs/changes-todo.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@ of the Beacon project site(s) as well as with overarching repository organizatio
55

66
## Changes
77

8+
### 2024-12-13: Beacon Version 2.1.1 Released
9+
10+
A new Beacon version was released on Dec 13, 2024. While this is a minor point
11+
release of the Beacon Standard, _i.e._ does not contain breaking changes compared
12+
to 2.1.0, it provides a large number of bug fixes and cosmetic improvements such
13+
as better VRS alignment. Please see the [release notes](https://github.com/ga4gh-beacon/beacon-v2/releases/tag/v2.1.1) for details.
14+
815
### 2024-08-08: [genomebeacons.org](https://genomebeacons.org) now default Beacon domain
916

1017
We have now migrated towards general use fo the `genomebeacons.org` domain for
@@ -21,6 +28,14 @@ has been made with the **F**requently **A**sked **Q**uestions section which is n
2128
The old domain [beacon-project.io](https://beacon-project.io) still exists but
2229
is only used for forwarding.
2330

31+
### 2024-07-19: Beacon Version 2.1.0 Released
32+
33+
A new Beacon version was released on July 19, 2024. This is a point release of
34+
the Beacon Standard and includes following changes:
35+
36+
- Relocated TypedQuantity required to proper level of the schema for complexValue
37+
- Added end and start entities for ageRange and iso8601duration for age
38+
- Filtering terms scopes changed from string to array of strings
2439

2540
### 2023-06-12: Restructured and extended documentation
2641

‎docs/code-organization.md‎

Lines changed: 3 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -29,115 +29,21 @@ The `gh-pages` branch is generated from the `/docs` directory through its `mkdoc
2929

3030
These are the branches that are meant to fix some bugs that break the specifications and need an urgent fix. The branches are directly deployed towards the `main` branch.
3131

32-
### `entry-type-definitions-cleanup`
33-
34-
This branch aims to redefine the wording of the entry types in a way that makes more clear what are the entry types. As the old definitions could mislead to some confusions, this is a sensible change that is needed to directly affect the current modification.
35-
36-
<b>Current status:</b><span style="color:blue">Waiting for PR to be accepted.</span>
37-
38-
### `hotfix_filteringTermsResults`
39-
40-
As the beaconFilteringTermsResults.json "type" property of the FilteringTerm is ambiguous, this branch has the objective to fix this and make filtering terms object to be operative and ready to point to the filtering terms type.
41-
42-
<b>Current status:</b><span style="color:blue">Waiting for PR to be accepted.</span>
43-
4432
### `schema-urgent-fixes`
4533

4634
Some of the instances of the schema were missing attributes and other aspects that are required to make a beacon work. This is mandatory to be urgently fixed and this is the purpose of this branch deployment.
4735

48-
<b>Current status:</b><span style="color:blue">Waiting for PR to be accepted.</span>
49-
36+
### Clean-up branches
5037

38+
There is always a number of branches used to implement fixes and test features.
39+
Please participate in the Beacon developer calls if you want to stay up-to-date...
5140

5241
## Feature and subfeature branches
5342

5443
The feature branches are the branches that bring a lot of changes together to change some specific part of the specifications. They can be composed by different subfeature branches that commit to them or just have one single working branch. The feature branches commit to the `develop` branch as they are the changes that will lead beacon to be upgraded to a new version. The subfeature branches commit to their parent feature branch, as they are a microchange of all the aspects that have to change in a new feature that is being developed. The branches are named as the main purpose of them, so it is made very clear what is the working area of them and the subfeature branches add the name of the feature branch they belong as a prefix followed by an underscore. The list of these feature branches with their subfeature branches is the one shown next:
5544

56-
### `clean-up`
57-
58-
#### `clean-up_sticky_modified_files`
59-
60-
<b>Current status:</b><span style="color:blue">Last commit by @jrambla.</span>
61-
62-
#### `clean-up_renaming_entity_to_entry_type`
63-
64-
<b>Current status:</b><span style="color:blue">Added in framework-refactor-entry-type-definitions branch by @mbaudis and waiting for a PR to be accepted.</span>
65-
66-
#### `clean-up_decouple-model-framework-refs`
67-
68-
<b>Current status:</b><span style="color:blue">Last commit by @mbaudis.</span>
69-
70-
#### `clean-up_move-CURIE-to-beaconCommonComponents`
71-
72-
<b>Current status:</b><span style="color:blue">This branch has not had any commit.</span>
73-
74-
#### `clean-up_de-snakify-token-names`
75-
76-
<b>Current status:</b><span style="color:blue">This branch has not had any commit.</span>
77-
78-
#### `clean-up_refactor-analysys-pipeline-info`
79-
80-
<b>Current status:</b><span style="color:blue">Last commit by @mbaudis.</span>
81-
82-
### `resultsets`
83-
84-
#### `resultsets_remove-requirement-results-resultsCount`
85-
86-
<b>Current status:</b><span style="color:blue">Last commit by @mbaudis.</span>
87-
88-
### `requestParameters`
89-
90-
#### `requestParameters_genomicVariations-fix`
91-
92-
<b>Current status:</b><span style="color:blue">Last commit by @mbaudis.</span>
93-
94-
#### `requestParameters_list-parameters-with-comma`
95-
96-
<b>Current status:</b><span style="color:blue">This branch has not had any commit.</span>
97-
98-
### `phenopackets`
99-
100-
#### `phenopackets_standards-alignment`
101-
102-
<b>Current status:</b><span style="color:blue">Last commit by @mbaudis.</span>
103-
104-
### `network`
105-
106-
#### `network_aggregator-and-networks-support`
107-
108-
<b>Current status:</b><span style="color:blue">This branch has not had any commit.</span>
109-
110-
#### `network_meta-add-aggregator-flag`
111-
112-
<b>Current status:</b><span style="color:blue">Last commit by @mbaudis.</span>
113-
114-
### `anyOf`
115-
116-
#### `anyOf_filteringTerms`
117-
118-
<b>Current status:</b><span style="color:blue">This branch has not had any commit.</span>
119-
120-
### `genomicVariations`
121-
122-
<b>Current status:</b><span style="color:blue">Waiting for PR to be accepted.</span>
123-
124-
### `received-filters`
125-
126-
<b>Current status:</b><span style="color:blue">Waiting for PR to be accepted.</span>
127-
128-
### `response-meta-add-warnings`
129-
130-
<b>Current status:</b><span style="color:blue">Waiting for PR to be accepted.</span>
131-
132-
### `framework-refactor-entry-type-definitions`
133-
134-
<b>Current status:</b><span style="color:blue">Waiting for PR to be accepted.</span>
135-
136-
137-
13845

13946

14047

14148

142-
==TBD==
14349

‎docs/implementations/org.progenetix.md‎

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
<h2>Progenetix & Beacon<span style="color: red; font-weight: 800;"><sup>+</sup></span></h2>
2+
<h2>Progenetix & Beacon<span style="color: red; font-weight: 800;"><sup>+</sup></span> - driven by [`bycon`](https://bycon.progenetix.org)</h2>
33

44
The Beacon+ implementation - developed in the Python & MongoDB based [`bycon` project](https://github.com/progenetix/bycon/) -
55
implements an expanding set of Beacon {{config.beacon_major_version}} paths for the [Progenetix](https://progenetix.org)
@@ -187,23 +187,4 @@ CNV statistics or binned genome calls.
187187

188188
<h3>Changes<img align="right" width="160px" src="https://progenetix.org/img/progenetix-logo-black.png"></h3>
189189

190-
* 2022-04-17: removed some non-standard examples (e.g. `variants_in_sample`)
191-
* 2021-11-02: added `/testMode` example
192-
* 2021-07-21: added [`/map`](https://progenetix.org/beacon/map) endpoint (incomplete/unser construction)
193-
* 2021-07-21: added [`/configuration`](https://progenetix.org/beacon/configuration) endpoint (incomplete/unser construction)
194-
* 2021-07-02: update for [`/filteringTerms`](https://progenetix.org/beacon/filteringTerms) endpoint to v2b4
195-
* 2021-06-25: updated for `datasets` parameter as object
196-
* 2021-06-24: Updated response structure conforming to v2b4:
197-
- `response_summary`
198-
- removal of `response` root element & direct use of `result_sets`
199-
* 2021-06-24: Updated query structure conforming to v2b4
200-
- `entityType` format fixed
201-
- `filters` now objects
202-
* 2021-06-23: New JSON POST example & topic
203-
* 2021-06-07: Added `variants_interpretations` example
204-
* 2021-05-29: New `resultSets` response format
205-
- no change to front-end or examples here but change of `bycon` backend
206-
* 2021-05-11: Added `/analyses`
207-
* 2021-05-02: Added base path for `BeaconInfoResponse`
208-
* 2021-04-26: First Version
209-
190+
Please see the detailed [`bycon` change tracker](https://bycon.progenetix.org/changes/).

0 commit comments

Comments
 (0)