update the plain-javascript README.md #458
Conversation
…ild Globalize and clarify some ambiguities
|
Hi @rxaviers / @jzaefferer, I've tried to submit a docs change (just a
Could you tell me what these errors refer to please? I'd be happy to fix them up if I knew! |
|
That's about the commit message, you can just ignore that. Or do a |
|
Thanks @jzaefferer - I'll ignore it as advised! |
| └── index.html | ||
| └── README.md |
There was a problem hiding this comment.
Can you update └── index.html for ├── index.html please? The same with supplemental.js.
|
@johnnyreilly thank you very much for your clarifying improvements. I have left a couple of comments above. Just let me know on any questions. Thanks |
|
@johnnyreilly just wondering if you had a chance to look at my comments? Thanks |
|
Hi @rxaviers, I've made changes following your comments. I've followed all your suggestions to the letter apart from the last. I think the 2 separate examples are valuable as they are - I hope that's okay? I've slightly rejigged it for clarity though. |
|
@johnnyreilly for some reason your last commit uses a different author name ("johnnyreilly" instead of "John Reilly"), that's why it no longer passes our CLA check. You could update that with `git --amend --author=... or squash all commits into one, as long as the remaining commit has the right author information. Or I guess @rxaviers could do that for you, when landing this. |
|
Tried and failed @jzaefferer 😢 Hopefully @rxaviers can sort it for me? |
|
Hi @johnnyreilly, I can squash your commits and keep "John Reilly" as your correct one. |
|
Great - go for it! |
| @@ -22,7 +22,7 @@ you want. But, as an exercise of this demo, we'll download it ourselves. So: | |||
| 1. Click at [cldrjs releases tab](https://github.com/rxaviers/cldrjs/releases). | |||
| 1. Download the latest package. | |||
| 1. Unzip it. | |||
| 1. Move its `dist/` files into `cldrjs` of this directory. | |||
| 1. Create a `cldrjs` directory alongside `index.html` and `README.md` and move the cldrjs `dist/` files into it. | |||
There was a problem hiding this comment.
@johnnyreilly, I believe we can improve this sentence for clarity.
@kswedberg do you have a suggestion to help us out here?
There was a problem hiding this comment.
Looks fine to me, @rxaviers . One thing that might make it more clear would be to break it up into 2 steps:
...
- Inside the unzipped directory, rename the
distdirectory tocldrjs. - Move the renamed
cldrjsdirectory from the unzipped folder to this demo's directory so that it appears alongsideindex.htmlandREADME.md.
I don't know, though. Maybe that just makes it overly complicated.
There was a problem hiding this comment.
What I found confusing was having cldrjs to reference to two different things: the empty just-created directory and the unzipped directory. But, we can ignore my comment considering you both think this is clear. :)
Thanks @kswedberg for your prompt answer.
Looks good to me. I have left two comments though in other sentences. Sorry for the ping pong, which delays landing your PR. But, hopefully my last observation/suggestion. |
| │ └── cldr | ||
| │ ├── event.js | ||
| │ └── supplemental.js | ||
| └── index.html | ||
| │ └── unresolved.js |
There was a problem hiding this comment.
unresolved.js isn't used by this example, therefore I think it shouldn't be listed here (for simplicity).
|
Thank you @johnnyreilly |
Hi!
I'm just investigating the migration story from 0.x to 1.x and as a first step I thought I'd give the plain JavaScript example a go. I got there after a little fiddling and so I thought I'd try and clarify the steps required in the README.md. I hope that's okay?
Best,
John