Skip to content

Commit 68938c9

Browse files
committed
Update doc for platform changes to support rules freeze
- delete obsolete mermaid diagram - clarify treatment of normative vs. best practice rules - address github deployment for rule catalog docs (IVS-822)
1 parent 7f50f11 commit 68938c9

2 files changed

Lines changed: 29 additions & 52 deletions

File tree

adapt_platform.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,20 @@ will need to be firewalled from the production environment that is being used to
1111
These are the steps involved and business rules, with rough timelines.
1212

1313
1. exit beta, 1.0.0 released Q1 2026
14-
2. no new rule or rule fixes for version 1
15-
3. other performance improvements, UI adjustments are ok - but nothing that affects scorecards
14+
2. no new rules or rule fixes for version 1 that affect vendors seeking scorecard-based certification
15+
- Warnings raised by Industry Best Practice (IBP) rules are not included in the assessment of a specific vendor tool version
16+
- Therefore new IBP rules may be released under the 1.0 major version label when deemed appropriate by the product manager
17+
3. other performance improvements, UI adjustments are ok as they do not affect scorecard-based assessment
1618
4. new rules and rule fixes continue "behind the scenes"
1719
5. these new rules are available on a limited, invitation-only basis for beta testing
18-
- v2.0.0b1
19-
- v2.0.0b2
20-
- v2.0.0b3
20+
- v2.0.0-b1
21+
- v2.0.0-b2
22+
- v2.0.0-b3
2123
- ...
22-
6. Q4 2026 - rule freeze and change from beta to release candidate v2.0.0rc1
24+
6. Q4 2026 - rule freeze and change from beta to release candidate v2.0.0-rc1
2325
7. Q1 2027 - rule fixes only
24-
- v2.0.0rc2
25-
- v2.0.0rc3
26+
- v2.0.0-rc2
27+
- v2.0.0-rc3
2628
- ...
2729
8. End of Q1 2027 - release of 2.0.0 to PROD environment
2830

@@ -119,3 +121,22 @@ gitGraph
119121
checkout "validate/preview"
120122
merge "ifc-gherkin-rules/preview" tag:"2.0.0b2" type: HIGHLIGHT
121123
```
124+
125+
## Rule Catalog Documentation
126+
127+
The Github Workflow [pages-build-deployment](https://github.com/buildingSMART/ifc-gherkin-rules/actions/workflows/pages/pages-build-deployment)
128+
generates documentation of all rules and gherkin step implementations.
129+
This documentation is then deployed to branch-specific URLS, e.g.
130+
131+
[https://buildingsmart.github.io/ifc-gherkin-rules/branches/main/features/index.html]
132+
133+
and
134+
135+
[https://buildingsmart.github.io/ifc-gherkin-rules/branches/development/features/index.html]
136+
137+
and
138+
139+
[https://buildingsmart.github.io/ifc-gherkin-rules/branches/development/features/index.html]
140+
141+
Therefore this Github action does not require any changes to accommodate the new `preview` branch
142+
or any other adaptations to the platform to support the rules freeze.

docs/adapt_platform.mermaid

Lines changed: 0 additions & 44 deletions
This file was deleted.

0 commit comments

Comments
 (0)