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

Initial spec import #1

Closed
wants to merge 3 commits into from
Closed

Initial spec import #1

wants to merge 3 commits into from

Conversation

gkellogg
Copy link
Member

@gkellogg gkellogg commented Jun 8, 2018

Spec updated from CG for WG.

@gkellogg
Copy link
Member Author

gkellogg commented Jun 9, 2018

@iherman what needs to be done to get the formatted preview to work for this, and the other repos?

@iherman
Copy link
Member

iherman commented Jun 10, 2018

Hm. This should work, because the tool to preview is automatically installed for all W3C repos, including this one (and I have added the necessary config files). I suspect that it has problems with respec; afaik, if the respec process does not complete for whatever reasons, then there is no result appearing here.

Can you check it separately? A way to do that is to run something like below, with the obvious changes of the parameters:

https://labs.w3.org/spec-generator/?type=respec&url=https://w3c.github.io/wpub/?specStatus=FPWD;publishDate=2018-01-02;includePermalinks=false

Cc: @tobie

@gkellogg
Copy link
Member Author

The problem may be that the specs access files in json-ld-wg which are stuck in a PR. We should probably pull that so that they exist for the specs.

@tobie
Copy link
Member

tobie commented Jun 10, 2018

Hey folks, unfortunately, I don't have the time to do any support for pr-preview these days. I am considering offering support as a paid service however, so let me know if this is something you might be interested in.

@gkellogg
Copy link
Member Author

@iherman no luck; I tried https://labs.w3.org/spec-generator/?type=respec&url=https://raw.githubusercontent.com/w3c/json-ld-syntax/cg-import/index.html which results in a failed promise error, do you have any insight as to what's going on? It runs fine in my environment, of course.

@iherman
Copy link
Member

iherman commented Jun 13, 2018

@gkellogg,

I believe the issues is with

<script type="text/javascript" src="../json-ld-wg/common/common.js" class="remove"></script>

I am afraid the 'common' subdirectory will have to be duplicated for each document, and it cannot be kept at one place. B.t.w., the lab generator cannot go to that directory and, actually, this would also create, at some point, a problem with Echidna.

:-(

@iherman iherman mentioned this pull request Jun 13, 2018
@iherman
Copy link
Member

iherman commented Jun 13, 2018

@gkellogg I have made a version and a separate PR #2 where:

  • I have copied the content of the 'common' directory to the repository
  • Changed the references in index.html (including the two html import statements)
  • While I was at it, I also updated the Patent Policy reference in the respec header, as well as added a reference to the 2018 process.

The PR preview works now in #2. I propose to close this one, and merge #2.

@davidlehn
Copy link
Contributor

Do other specs have similar issues and have a good solution to keep common files in sync? Maybe just a README file in each spec common dir noting that people should edit the main wg common files and sync changes to each spec? Or maybe it's just not a big deal to do by hand?

@gkellogg
Copy link
Member Author

It sort of misses the point of having common files, if they need to be duplicated, which is unfortunate. Certainly, we'll need to add a README that changes to any file in /common must be replicated to other repositories; as Ivan noted, they don't change too often. We should probably keep the main ones in json-ld-wg. Perhaps we can figure out a Travis CI check to make sure they haven't diverged.

I'll close PR #1 and replicate these changes to json-ld-api and json-ld framing PRs.

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.

4 participants