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

Restructure user docs on MarkBind syntax #668

Merged
merged 5 commits into from
Feb 10, 2019

Conversation

damithc
Copy link
Contributor

@damithc damithc commented Feb 5, 2019

What is the purpose of this pull request? (put "X" next to an item, remove the rest)
• [x] Documentation update

This is another update to user docs, focusing on how we describe MarkBind syntax. Overview:

  • Minor refinements to the landing page
  • Extracted explanation of each syntax into a separate file in the userGuide/syntax/ folder.
  • Other pages that changed significantly:
    • Authoring Contents: added overviews of new pages
    • MarkBind Syntax Overview: Previously this page contained all syntax (except components). Not it contains an overview only.
    • Formatting Contents: new page. Describes all syntax used for basic formatting.
    • Using Components: Revised to pull content from syntax/*.mbdf pages
    • Using HTML, JavaScript, CSS: new page.
    • Tweaking the Page Structure: Revised to pull content from syntax/*.mbdf pages
    • Reusing Contents: Revised to pull content from syntax/*.mbdf pages
    • Making the Site Searchable: Revised to pull content from syntax/*.mbdf pages
    • References
      • Reader-Facing Features: New page. Shows features that will be visible to readers.
      • Full Syntax Reference: Alphabetical list of all syntax
      • Syntax Cheat Sheet: new page

@damithc
Copy link
Contributor Author

damithc commented Feb 5, 2019

Ready for review. As we did with the previous one, we can fix only major issues before merging. Minor issues can be fixed as followup PRs. It will take a few more iterations before the user docs are as polished as we want them to be.

@yamgent
Copy link
Member

yamgent commented Feb 7, 2019

@Chng-Zhi-Xuan will need your help in reviewing this PR.

@damithc
Copy link
Contributor Author

damithc commented Feb 7, 2019

For some reason, the Netlify preview appears broken 🤔

@damithc
Copy link
Contributor Author

damithc commented Feb 7, 2019

Resolved merge conflict.

@damithc
Copy link
Contributor Author

damithc commented Feb 7, 2019

Looks like netlify is getting some erros:

1:37:40 PM:  v1.17.2
1:37:40 PM: info: Website generation started at 05:37:40
1:37:40 PM: info: Building assets...
1:37:40 PM: info: Assets built
1:37:40 PM: info: Generating pages...
1:37:40 PM: error: Error: No such file: /opt/build/repo/docs/userGuide/markbindSyntaxOverview.md
1:37:40 PM: Missing reference in /opt/build/repo/docs/userGuide/authoringContents.md
1:37:40 PM: error: Error: No such file: /opt/build/repo/docs/userGuide/markbindSyntaxOverview.md
1:37:40 PM: Missing reference in /opt/build/repo/docs/userGuide/authoringContents.md
1:37:40 PM: error: Template render error: (unknown path)
1:37:40 PM:   Template render error: (unknown path)
1:37:40 PM:   Error: template not found: userGuide/fullSyntaxReference.md
1:37:40 PM: Error while preprocessing '/opt/build/repo/docs/userGuide/authoringContents.md'
1:37:40 PM: error: Error: No such file: /opt/build/repo/docs/userGuide/syntax/navBars.mbdf
1:37:40 PM: Missing reference in /opt/build/repo/docs/userGuide/fullSyntaxReference.md
1:37:40 PM: error: Error: No such file: /opt/build/repo/docs/userGuide/syntax/searchBars.mbdf
1:37:40 PM: Missing reference in /opt/build/repo/docs/userGuide/fullSyntaxReference.md
1:37:40 PM: error: Template render error: (unknown path)
1:37:40 PM:   Template render error: (unknown path)
1:37:40 PM:   Error: template not found: userGuide/fullSyntaxReference.md
1:37:40 PM: Error while preprocessing '/opt/build/repo/docs/userGuide/markBindSyntaxOverview.md'


{% set pages = [
['Adding Pagess', 'addingPages'],
['MarkBind Syntax Overview', 'markbindSyntaxOverview'],
Copy link
Contributor

@nicholaschuayunzhi nicholaschuayunzhi Feb 7, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  ['Adding Pages', 'addingPages'],
  ['MarkBind Syntax Overview', 'markBindSyntaxOverview'],

@damithc
Copy link
Contributor Author

damithc commented Feb 8, 2019

Let's merge this if there are no big problems -- if not, it will create merge conflict headaches for all the incoming PRs. No need to review content itself as I will be submitting more PRs to refine content further. We can do a fine-grain review of the text when the content is stable.

@yamgent yamgent added this to the v1.17.4 milestone Feb 10, 2019
@yamgent yamgent merged commit 1561929 into MarkBind:master Feb 10, 2019
@yamgent
Copy link
Member

yamgent commented Feb 11, 2019

On a side note for performance: Build time for documentation seems to have doubled since this PR was merged (was around ~3.174s before, now it is ~7.697s).

@damithc
Copy link
Contributor Author

damithc commented Feb 11, 2019

On a side note for performance: Build time for documentation seems to have doubled since this PR was merged (was around ~3.174s before, now it is ~7.697s).

Due to more source files, and more output files? 🤔 There are some nunjucks scripts too.

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