Skip to content

Commit

Permalink
Merge branch 'main' of [email protected]:standardapi/odata-specs.git into
Browse files Browse the repository at this point in the history
main
  • Loading branch information
HeikoTheissen committed May 16, 2023
2 parents 98bf14b + afb3578 commit e65832b
Showing 1 changed file with 15 additions and 11 deletions.
26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,18 @@ Run `npm start` to start a Node.js server and access the HTML pages at, for exam

## To Do

- Auto-generate table of content with links to sections
- Make section headlines self-links as in the [Core specifications](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_ServiceModel)
- Use same anchor naming convention `sec_CondensedHeadlineText` as in Core specifications?
- Fixed scaling of pictures instead of auto-scaling to page witdh?
- Align structure of `/docs` subfolders with OASIS publication folder structure, see https://docs.oasis-open.org/openc2/oc2ls/v1.0/cs02/
- OASIS filenames for `.md` and `.html` instead of constant `README.md` and `index.html`
- include OASIS CSS file in `styles` subfolder to have snapshot of styles at point of document production
- Use OASIS work product abbreviation for folder names: `odata-data-aggregation-ext` instead of `odata-aggr`
- Cross-check compliance with [OASIS Editor's Manual](https://www.oasis-open.org/member-resources/)
- [Part 3: Work Product Structure](https://docs.google.com/document/d/1yA-wt2wB4NOpgoQ81VBfuJ1WPA1GK_BuddiVP_L6BnU/edit#heading=h.bi4fdsq13pue): How are specifications structured and named at OASIS? What is the crucial metadata?
- [Part 4: Work Product Preparation](https://docs.google.com/document/d/10lt8f2pn_ebZTsWJiGYiWYzyo6NbjuTskvDcS2tSyPw/edit#heading=h.bi4fdsq13pue): How do you actually craft the work product? What steps do you need to take to move it forward?
- [X] Auto-generate table of content with links to sections
- [X] Make section headlines self-links as in the [Core specifications](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_ServiceModel)
- [ ] Use same anchor naming convention `sec_CondensedHeadlineText` as in Core specifications?
- [ ] Fixed scaling of pictures instead of auto-scaling to page witdh?
- [ ] Align structure of `/docs` subfolders with OASIS publication folder structure, see https://docs.oasis-open.org/openc2/oc2ls/v1.0/cs02/
- [X] OASIS filenames for `.md` and `.html` instead of constant `README.md` and `index.html`
- [ ] include OASIS CSS file in `styles` subfolder to have snapshot of styles at point of document production
- [X] Use OASIS work product abbreviation for folder names: `odata-data-aggregation-ext` instead of `odata-aggr`
- [ ] Cross-check compliance with [OASIS Editor's Manual](https://www.oasis-open.org/member-resources/)
- [ ] [Part 3: Work Product Structure](https://docs.google.com/document/d/1yA-wt2wB4NOpgoQ81VBfuJ1WPA1GK_BuddiVP_L6BnU/edit#heading=h.bi4fdsq13pue): How are specifications structured and named at OASIS? What is the crucial metadata?
- [ ] [Part 4: Work Product Preparation](https://docs.google.com/document/d/10lt8f2pn_ebZTsWJiGYiWYzyo6NbjuTskvDcS2tSyPw/edit#heading=h.bi4fdsq13pue): How do you actually craft the work product? What steps do you need to take to move it forward?
- [ ] Check MD/HTML for broken and inconsistent links (similar to what we currently do with the `ExtractHyperlinksToExcel` Word macro
- [ ] Request starter Markdown document and align our MD files with it
- [ ] Check diagram sources (Visio, PowerPoint) into repository
- [ ] Describe export process for diagrams to SVG

0 comments on commit e65832b

Please sign in to comment.