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

WoT toolchain diagram added #1919

Merged
merged 9 commits into from
Nov 16, 2023
Merged

WoT toolchain diagram added #1919

merged 9 commits into from
Nov 16, 2023

Conversation

mahdanoura
Copy link
Contributor

@mahdanoura mahdanoura commented Nov 15, 2023

BPMN diagram showing the current process required for generating the WoT specifications. Links to Specification Generation Tooling

@mahdanoura mahdanoura added the pipeline automation, actions, convenience scripts label Nov 15, 2023
Copy link
Contributor

@egekorkan egekorkan left a comment

Choose a reason for hiding this comment

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

The diagram itself is fine and much appreciated. Some remarks:

  • Can you push the source file as well?
  • Can you add legend to what the small icons mean?

Copy link
Contributor

@danielpeintner danielpeintner left a comment

Choose a reason for hiding this comment

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

I think it should be put in a dedicated folder .. maybe with a README along with it

images/ seems not to be the right place

@egekorkan
Copy link
Contributor

Call of 15.11:

  • This diagram but actually our process should become simpler
  • We can have some snippets of the big diagram as separate figures and explain them on their own. The big figure can be used as a reference.
  • @lu-zero : It is better to spend time to simplify the process, rather than optimizing the figure.
  • @egekorkan : There is also the step to generate the TM Schema
  • Noting that black arrows are outputs and are mandatory for the publication process, either as the spec and its PNGs or as part of the wot-resources
  • 1-2 sentences per step (in another document) would be nice
  • Another figure would be nice to document what happens to the index.html with each publication, currently documented at https://github.com/w3c/wot-thing-description/blob/main/publication/README.md

@egekorkan egekorkan added Tooling topics around tooling for the specification useful-documentation good for documentation purposes later on labels Nov 15, 2023
@egekorkan
Copy link
Contributor

Before merging:

  • the source file should be added
  • A legend to what the small icons should be added
  • A new folder called "toolchain" should be created where we can also have the associated text/guide in form of a readme.

Once those are done, we can merge the PR asynchronously.

@egekorkan
Copy link
Contributor

As agreed in the call yesterday, we will merge this since the points above are addressed. For more significant improvements, I will open an issue to track it. Thanks @mahdanoura !

@egekorkan egekorkan merged commit f810d84 into w3c:main Nov 16, 2023
1 check passed
@egekorkan egekorkan mentioned this pull request Nov 16, 2023
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pipeline automation, actions, convenience scripts Tooling topics around tooling for the specification useful-documentation good for documentation purposes later on
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants