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

Quickstart tutorial, incorrect link fix #64

Merged
merged 4 commits into from Feb 16, 2018
Merged

Conversation

mathias-brandewinder
Copy link
Contributor

  1. added a QuickStart tutorial, walking through creating a simple chart from VSCode using Paket. The goal is to have a beginner friendly, fail-proof example with a chart created within a couple of minutes.
  2. also fixed issue Link in Documentation points to wrong repository #63 - an incorrect link on the front page.
    We haven't added the QuickStart to the links, would appreciate feedback first. We also assume, based on the repository, that the generated html docs should also be added to the repository.
    As a next step, we'd like to take a stab at reorganizing the index page, and perhaps also adding a "contributing" guide.
    (this is joint work with @thuris and @SergeyZa)

@mathias-brandewinder
Copy link
Contributor Author

Ping!

@tpetricek
Copy link
Member

This looks great to me. Two things:

  • Are the changes in docs/tutorial.html intentional? This should be auto-generated file.
  • Can you run build GenerateDocs? I think this should overwrite all the HTML documents (it might also replace the URL changes above) and generate HTML from the walkthrough so that it can be included in the PR (and merging the PR will make it go online immediately).

@mathias-brandewinder
Copy link
Contributor Author

Thanks for the feedback - will look into the GenerateDocs part!

@mathias-brandewinder
Copy link
Contributor Author

@tpetricek

  1. I can run GenerateDocs, which re-generates locally the contents of the docs folder.
  2. docs/tutorial.html is a misunderstanding on our part. We were not certain if we were supposed to generate this with the PR, or if this was automatic and would generate/overwrite the existing docs when merged.
  3. As an additional note, when I run GenerateDocs, the resulting links in the html are slightly different on my machine from what is currently in the repo. Don't know if this matters, but I thought I would mention it.

So, just to be clear, my understanding is that:

  • we should check locally by running GenerateDocs that the html docs look all right,
  • we should just submit the docsrc/quickstart.fsx and docsrc/index.fsx, but not the generated html.

Should I re-submit the PR, just without tutorial.html changes included?

Otherwise, we haven't included a link to the quickstart in the mean page or the links on the side yet - we weren't sure if our changes would be worthwhile.

cc @thuris

@tpetricek tpetricek merged commit ce365ff into fslaborg:master Feb 16, 2018
@tpetricek
Copy link
Member

Okay, I'm getting back to this now - I think the broken link issue is a result of an earlier change that has nothing to do with this. I'm trying to fix this now.

@tpetricek
Copy link
Member

Merged and published now. I also added link to your new page.

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