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

file naming and section numbering #16

Closed
tumregels opened this issue Mar 20, 2019 · 2 comments
Closed

file naming and section numbering #16

tumregels opened this issue Mar 20, 2019 · 2 comments

Comments

@tumregels
Copy link
Contributor

tumregels commented Mar 20, 2019

@ericxiao251 I would like to suggest a few fixes. So here are they

  1. The naming of the ipynb files can cause problems for gitbook.
  • You should remove/change the brackets () from filenames. I fixed it by substituting with <> here. Gitbook fails to convert md into html when there are () in file name.
  • Also remove ? from file name. This also causes gitbook to fail.
  1. The section numbering should be adjusted.

For example for chapter 2 you have

  • Chapter 2 - Exploring the Spark APIs
    • [Section 1.1 - Struct Types](Chapter 2 - Exploring the Spark APIs/Section 1.1 - Struct Types.md)
    • [Section 1.2 - Arrays and Lists](Chapter 2 - Exploring the Spark APIs/Section 1.2 - Arrays and Lists.md)
    • [Section 1.3 - Maps and Dictionaries](Chapter 2 - Exploring the Spark APIs/Section 1.3 - Maps and Dictionaries.md)

But it would be better to have

  • Chapter 2 - Exploring the Spark APIs
    • [Section 2.1 - Struct Types](Chapter 2 - Exploring the Spark APIs/Section 2.1 - Struct Types.md)
    • [Section 2.2 - Arrays and Lists](Chapter 2 - Exploring the Spark APIs/Section 2.2 - Arrays and Lists.md)
    • [Section 2.3 - Maps and Dictionaries](Chapter 2 - Exploring the Spark APIs/Section 2.3 - Maps and Dictionaries.md)
  1. Also spark-syntax/README.md file is a bit heavy + has numbering problem (chapter 3 has section 4.1 and 4.2).
@ericxiao251
Copy link
Owner

Fixed point 3!

For point 2, I see what you mean... Hmmm ya i have sub sections in the chapters, i'll see if i can fix the script for that :).

For point 1, noted, I'll update that as well!

@tumregels
Copy link
Contributor Author

tumregels commented Mar 21, 2019

Great!

Also thanks for mentioning in the Acknowledgements section

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

No branches or pull requests

2 participants