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

Clean up/expand section 9, fix ExposedThing/ConsumedThing, terminology fixes, spell check #176

Merged
merged 15 commits into from
Mar 25, 2019

Conversation

mmccool
Copy link
Contributor

@mmccool mmccool commented Mar 25, 2019

Ready to merge. This WILL require a full review, it's (unfortunately) not just editorial...

  • Figures needed "Thing Directory" changed to "Thing Directory A" (or B) to match the text.
  • All instances of ExposedThing changed to Exposed Thing and tagged (globally)
  • All instances of ConsumedThing changed to Consumed Thing and tagged (globally)
  • Various other bits of terminology changed, e.g. server to WoT Server where appropriate. Note: I did sometime use "device" or "application" when I wanted to be vague about whether they are clients or servers.
  • Change in first paragraph focuses purpose of section on demonstrating how WoT Thing implementations are connected into various topologies. I took out the discussion of "components" since I think it was a relic from when this section also discussed internal structures of implementations. In general I thing we want to focus this section on topological and deployment issues and examples. Content that discusses internal structure should be moved to the previous section on implementation...
  • A couple of "in more complex scenarios" added. I put these after the figures since the figures don't reflect some of the topics discussed in these paragraphs: NAT traversal with local Servient as a client opening a tunnel using a "custom" protocol; cloud applications that are servers.
  • A lot more edits than I expected in all but the last section to get things aligned with the rest of the text, and in particular to not pigeonhole devices as server and cloud applications as client
  • Split the last section into two sub-sections for each case.
  • Spell check (global)

@mmccool mmccool assigned takuki and mlagally and unassigned takuki and mlagally Mar 25, 2019
@mmccool mmccool requested review from mlagally and takuki March 25, 2019 03:31
@mmccool
Copy link
Contributor Author

mmccool commented Mar 25, 2019

PLEASE REVIEW. Unfortunately this is not just editorial. Not ready to merge (I need to fix some things in the figures) but the text is ready for review.

@mmccool
Copy link
Contributor Author

mmccool commented Mar 25, 2019

Fixed ExposedThing and ConsumedThing globally, addressing #171, which can be closed if this PR is merged.

@mmccool mmccool mentioned this pull request Mar 25, 2019
@mlagally
Copy link
Contributor

mlagally commented Mar 25, 2019

@mmccool Great work.
I noticed that there are 4 respec issues in the PR, somehow the links to the following terminology entries don't work:

  • WoT Client
    *WoT Servient
  • WoT Server

WoT Servient is called Servient in the terminology section, I suggest to rename and move.
Not sure why the other links are not recognized.

The text refers to "Thing Directory A" and "Thing Directory B" but these were not labelled in the figure.  Fixed.
@mmccool
Copy link
Contributor Author

mmccool commented Mar 25, 2019

I will fix the Respec issues. I put some punctuation inside the anchor tags...

@mlagally
Copy link
Contributor

I already fixed it on my branch which I created based on yours.

@mlagally
Copy link
Contributor

#179

@mmccool
Copy link
Contributor Author

mmccool commented Mar 25, 2019

Uhmm... we may have fixed the respec issues differently. Also I found one extra untagged version of Servient that I fixed while I was at it. I also see you fixed the chapter structure... I fixed that too. Sorry, I promised to not touch the text, then I did :(. Also I just uploaded fixed pictures which you may or may not have.

@mlagally
Copy link
Contributor

I suggest we keep the term WOT Servient, to be aligned with WoT Client, WoT Server.
In my PR I moved the definition of Servient to WoT servient and just made Servient a synonym for WoT Servient. Renaming it all over the text would break the flow ...

@mmccool
Copy link
Contributor Author

mmccool commented Mar 25, 2019

How about I leave things alone for half an hour, let you patch things up, then I will check here again and if you have review comments, I can address them. If you make PRs against my repo I can merge them though.

@mlagally
Copy link
Contributor

Ok

@mmccool
Copy link
Contributor Author

mmccool commented Mar 25, 2019

I agree with WoT Servient as opposed to just Servient, it looks odd next to WoT Server and WoT Client. However... not the most pressing issue. Let's just make an issue and deal with it post-TAG-submission. Although allowing either WoT Servient or Servient is fine, too.

@mmccool mmccool changed the title WIP: Clean up section 9 Clean up/expand section 9, fix ExposedThing/ConsumedThing, terminology fixes, spell check Mar 25, 2019
@mmccool
Copy link
Contributor Author

mmccool commented Mar 25, 2019

After merging I checked Respec and the section structure -- both look good. Synonym for WoT Servient is also there. Looks to be in good shape to merge now... waiting for any more specific review comments, though.

@mlagally mlagally merged commit 120ae83 into w3c:master Mar 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants