Notes on README-DEV.adoc

[syedriko]

1. Should we make README-DEV.adoc a regular text file README-DEV.txt, given it describes how to generate human-readable text from asciidoc?
2. It seems we need to lose the -g from the 'npm install' or we don't get the node_modules directory the doc refers to in the end
3. We need to add the following to dev-site.yml

asciidoc:
  attributes:
    tutorial-namespace: knativetutorial
  extensions:
    - ./lib/copy-to-clipboard.js

4. "open the server index in a browser" does not happen for me on Fedora, I need to manually browse http://localhost:5353
5. why not add dev-site.yml as a file to the project and remove its contents from README-DEV?
6. "automatically update the HTML when the asciidoc source changes." Sometimes, I'm not seeing HTML updates in the browser, even though the HTML in gh-pages is updated. Cleaning browser's cache fixes this.

[kameshsampath]

@syedriko I guess this is address in #121 , can you confirm to close ? I have merged the PR

[alanconway]

1. Should we make README-DEV.adoc a regular text file README-DEV.txt, given it describes how to generate human-readable text from asciidoc?

I'm fine either way. I picked adoc as it's consistent with other files but .txt is justified by tradition and marks it out as not part of the tutorial.

2. It seems we need to lose the -g from the 'npm install' or we don't get the node_modules directory the doc refers to in the end

My bad - I flipped between with and without and probably ended up in the wrong place.

3. We need to add the following to dev-site.yml

asciidoc:
  attributes:
    tutorial-namespace: knativetutorial
  extensions:
    - ./lib/copy-to-clipboard.js

OK

1. "open the server index in a browser" does not happen for me on Fedora, I need to manually browse http://localhost:5353

That's a typo if it still says that - I took out the auto-open as it was not really helpful and possibly a problem.

2. why not add dev-site.yml as a file to the project and remove its contents from README-DEV?

Makes sense.

3. "automatically update the HTML when the asciidoc source changes." Sometimes, I'm not seeing HTML updates in the browser, even though the HTML in gh-pages is updated. Cleaning browser's cache fixes this.

Didn't see that but don't doubt it. I can't think of any way we can improve that.

[syedriko]

   why not add dev-site.yml as a file to the project and remove its contents from README-DEV?

Makes sense.

I'm not sure about this one. gulp by default looks at gulpfile.js which hardcodes dev-site.yml. Am I going to break the public website build by including dev-site.yml into the repo? Also, dev-site.yml is mentioned in .gitignore, I'm wondering why.

[alanconway]

On Mon, Apr 8, 2019 at 2:54 PM Sergey Yedrikov ***@***.***> wrote: why not add dev-site.yml as a file to the project and remove its contents from README-DEV? Makes sense. I'm not sure about this one. gulp by default looks at gulpfile.js which hardcodes dev-site.yml. Am I going to break the public website build by including dev-site.yml into the repo?

Good point, I'm not sure about that.

Also, dev-site.yml is mentioned in .gitignore, I'm wondering why.

I'm guessing because it's deliberately created outside of git control for development and it would be annoying to always see it in git status, and maybe because it would be a problem if it accidentally got checked in.

…

— You are receiving this because you commented. Reply to this email directly, view it on GitHub <#119 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AHa6XoHOwpT7PnfRjgvoLH9z2J-I_WR9ks5ve5BsgaJpZM4cgj2E> .

[kameshsampath]

since we have this already am closing this issue