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.

Sign up for GitHub

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

Jump to bottom

[CLOSED] Update Web Platform Docs #8623

Open
core-ai-bot opened this issue Aug 30, 2021 · 20 comments
Open

[CLOSED] Update Web Platform Docs #8623

core-ai-bot opened this issue Aug 30, 2021 · 20 comments

Comments

@core-ai-bot
Copy link
Member

Issue by MarcelGerber
Sunday Oct 26, 2014 at 18:26 GMT
Originally opened as adobe/brackets#9686

Finally got a fix for #6027.
Updated css.json to include the latest data using this Node script.

The only remaining issue (which has existed before): The values are not in any useful order.

Changes (properties added/removed): https://gist.github.com/MarcelGerber/bfdd47849cf58c90a5cd

MarcelGerber included the following code: https://github.com/adobe/brackets/pull/9686/commits
@core-ai-bot
Copy link
Member Author

Comment by MarcelGerber
Sunday Oct 26, 2014 at 20:04 GMT

Forgot to mention: This also updates all URLs from http:// to https:// (while they are currently auto-redirected). Not a big thing, but worth a mention.

@core-ai-bot
Copy link
Member Author

Comment by Mark-Simulacrum
Sunday Oct 26, 2014 at 21:20 GMT

Not sure if this is something to do with your script, but I found that opening Quick Docs on the CSS flex property has an odd heading, that looks like this:

<[[css/properties/flex-grow|flex-grow]]> <[[css/properties/flex-shrink|flex-shrink]]> <[[css/properties/flex-basis|flex-basis]]>

and is supposed to look like this, with each item being a link.

<flex-grow> <flex-shrink> <flex-basis>

@core-ai-bot
Copy link
Member Author

Comment by le717
Monday Oct 27, 2014 at 01:15 GMT

:D

@core-ai-bot
Copy link
Member Author

Comment by MarcelGerber
Monday Oct 27, 2014 at 01:26 GMT

Oh damn. At least, I don't need lodash.unescape any more.
@Mark-Simulacrum I've fixed the bug you mentioned, and probably (hopefully) thousands more.

@core-ai-bot
Copy link
Member Author

Comment by Mark-Simulacrum
Monday Oct 27, 2014 at 01:42 GMT

Found another issue with the Inline Docs for the alignment-adjust property. The values of the property are empty in the downloaded file; here is the JSON for it:

"css\/properties\/alignment-adjust": {
            "SUMMARY": "",
            "INITIALVALUE": "",
            "ID": "css\/properties\/alignment-adjust",
            "ANIMATABLE": false,
            "COMPUTEDVALUE": "",
            "URL": "http:\/\/docs.webplatform.org\/wiki\/css\/properties\/alignment-adjust",
            "STATUS": "",
            "VALUES": [

            ]
        }

The Docs display just the title and nothing else, I would expect them to not appear at all.

@core-ai-bot
Copy link
Member Author

Comment by MarcelGerber
Monday Oct 27, 2014 at 02:00 GMT

@Mark-Simulacrum Your JSON snippet is part of the old file ;) But you're right, there are such cases with the updated file as well, like for css/properties/behavior. I did this on purpose as call to map() in InlineDocsViewer.js expects VALUES to be an array, but it's probably better to just add a condition there.

PS: Thanks for taking a look!

@core-ai-bot
Copy link
Member Author

Comment by Mark-Simulacrum
Monday Oct 27, 2014 at 02:09 GMT

Is it intentional that the (new) JSON file has a space after every TITLE string? (e.g."TITLE": "justify ").

@core-ai-bot
Copy link
Member Author

Comment by Mark-Simulacrum
Monday Oct 27, 2014 at 02:10 GMT

Actually, upon further inspection, every string in the file ends with a space. Is this something in update-docs.js?

@core-ai-bot
Copy link
Member Author

Comment by MarcelGerber
Monday Oct 27, 2014 at 02:16 GMT

It's something instaview (the Wikitext parser) does. But I have to admit, I actually like it as it somehow makes Brackets way faster when viewing that file, probably due to Word Wrap being less performances heavy.

@core-ai-bot
Copy link
Member Author

Comment by Mark-Simulacrum
Monday Oct 27, 2014 at 02:18 GMT

Here is a few more bugs, will update this list as I go along to prevent posting too many comments:

  • Many (if not all) summaries/descriptions start with <p> but the paragraph tag is not closed.
  • animation-fill-mode property, see forwards value section; rendering has {| class="mw-datatable os-suggest-results filehistory", seems out of place.

@core-ai-bot
Copy link
Member Author

Comment by MarcelGerber
Monday Oct 27, 2014 at 14:02 GMT

@Mark-Simulacrum A closing <p> tag is not required (see http://stackoverflow.com/questions/8460993/p-end-tag-p-is-not-needed-in-html), and InstaView omits it therefore.
The table bug is fixed, but our tables could use some design love.

@core-ai-bot
Copy link
Member Author

Comment by MarcelGerber
Monday Oct 27, 2014 at 15:05 GMT

I just removed the extra step required to convert the JSON data to a usable format.

@core-ai-bot
Copy link
Member Author

Comment by redmunds
Wednesday Nov 12, 2014 at 22:54 GMT

@MarcelGerber Thanks for taking a look at this. Those docs are way out-of-date.

It looks like update-docs.js is a nodejs module with a dependency of instaview that updates the css.json file -- is that right? If so, that's an awesome contribution!

At the very least, the README.md file should mention that and also have a recipe for installing and running it. Since this code is never run by Brackets and introduces a new dependency, I'm thinking it should be in a separate repo outside of Brackets, but I'm open to other opinions. Moving it to a separate repo would also make it much easier to get the changes into css.json into Brackets.

@core-ai-bot
Copy link
Member Author

Comment by MarcelGerber
Thursday Nov 13, 2014 at 15:09 GMT

Yep, the ‘update-docs.js‘ is a node script to update the css.json file using the WebPlatformDocs/MediaWiki API.
I'm not quite sure whether it belongs in the brackets repo or not - it's basically a maintenance script, and other maintenance helpers like set-release are in the brackets repo as well.
Talking of set-release, I could imagine a similar workflow with update-docs as well - running it every time a new Release is set would be great, to keep the docs up to date.

@core-ai-bot
Copy link
Member Author

Comment by redmunds
Thursday Nov 13, 2014 at 15:33 GMT

@MarcelGerber I didn't think about the Tools folder -- I was thinking about the Apify nodejs app for creating Brackets API docs which is at: https://github.com/jbalsas/apify

@core-ai-bot
Copy link
Member Author

Comment by MarcelGerber
Thursday Nov 13, 2014 at 18:07 GMT

@redmunds I've completely removed the Node script and took it over to https://github.com/MarcelGerber/update-wpd-docs.
I've created a README with update instructions as well.

@core-ai-bot
Copy link
Member Author

Comment by redmunds
Thursday Nov 13, 2014 at 23:20 GMT

I am seeing a WebPlatformDocs unit test fail:

should process all anchor tags

Error: Expected 1 to be 9.
    at new jasmine.ExpectationResult (file:///C:/Users/redmunds/dev/github/brackets-shell/Release/dev/test/thirdparty/jasmine-core/jasmine.js:114:32)
    at null.toBe (file:///C:/Users/redmunds/dev/github/brackets-shell/Release/dev/test/thirdparty/jasmine-core/jasmine.js:1235:29)
    at null.<anonymous> (file:///C:/Users/redmunds/dev/github/brackets-shell/Release/dev/src/extensions/default/WebPlatformDocs/unittests.js:210:39)
    at jasmine.Block.execute (file:///C:/Users/redmunds/dev/github/brackets-shell/Release/dev/test/thirdparty/jasmine-core/jasmine.js:1064:17)
    at jasmine.Queue.next_ (file:///C:/Users/redmunds/dev/github/brackets-shell/Release/dev/test/thirdparty/jasmine-core/jasmine.js:2096:31)
    at jasmine.Queue.start (file:///C:/Users/redmunds/dev/github/brackets-shell/Release/dev/test/thirdparty/jasmine-core/jasmine.js:2049:8)
    at jasmine.Spec.execute (file:///C:/Users/redmunds/dev/github/brackets-shell/Release/dev/test/thirdparty/jasmine-core/jasmine.js:2376:14)
    at jasmine.Queue.next_ (file:///C:/Users/redmunds/dev/github/brackets-shell/Release/dev/test/thirdparty/jasmine-core/jasmine.js:2096:31)
    at jasmine.Queue.start (file:///C:/Users/redmunds/dev/github/brackets-shell/Release/dev/test/thirdparty/jasmine-core/jasmine.js:2049:8)
    at jasmine.Suite.execute (file:///C:/Users/redmunds/dev/github/brackets-shell/Release/dev/test/thirdparty/jasmine-core/jasmine.js:2521:14)
    at jasmine.Queue.next_ (file:///C:/Users/redmunds/dev/github/brackets-shell/Release/dev/test/thirdparty/jasmine-core/jasmine.js:2096:31)

@core-ai-bot
Copy link
Member Author

Comment by redmunds
Thursday Nov 13, 2014 at 23:45 GMT

-ms-flex-pack is the only vendor-specific property -- should it be removed?

@core-ai-bot
Copy link
Member Author

Comment by MarcelGerber
Friday Nov 14, 2014 at 14:40 GMT

@redmunds Fixed the unit tests and removed the vendor-prefixed property.

@core-ai-bot
Copy link
Member Author

Comment by redmunds
Friday Nov 14, 2014 at 16:26 GMT

Thanks. Merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@core-ai-bot