Document adding new site content in DG #1153

Tejas2805 · 2020-03-27T22:11:31Z

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] Documentation update

What is the rationale for this request?
New developers who are contributing a new feature to MarkBind, also need to demonstrate it
by adding it to the test_site. It is not clearly mentioned currently how to do so.

What changes did you make? (Give an overview)
Added documentation on how to add new site content.

Provide some example code that this change will affect:

N.A.

Is there anything you'd like reviewers to focus on?
N.A.

Testing instructions:
Check the preview of the developer guide.

Proposed commit message: (wrap lines at 72 characters)

New developers contributing a new feature to MarkBind have a hard time 
adding new content to the test site.

Let's add documentation regarding how to do so.

* 'master' of https://github.com/MarkBind/markbind: Update tests Allow using 'none' footer attribute in frontmatter (MarkBind#1002) Support line numbers for code blocks (MarkBind#991) 2.11.0 Update test files due to changes in PR MarkBind#982 Update vue-strap version to v2.0.1-markbind.36 Make highlighting bold (MarkBind#1045) Support markdown for header attr in dropdown (MarkBind#1029) Add '_site' to the ignored folders in site.json (MarkBind#1046) Use path.join instead of string interpolation (MarkBind#1052) Implement box markdown header attributes parsing (MarkBind#1025) Make the position of top navbar fixed (MarkBind#982) Exclude *.md files from being copied over on build (MarkBind#1010) # Conflicts: # docs/css/main.css

* 'master' of https://github.com/MarkBind/markbind: 2.12.0 Update outdated test files Update vue-strap version to v2.0.1-markbind.37 Fix refactor to processDynamicResources (MarkBind#1092) Implement lazy page building for markbind serve (MarkBind#1038) Add warnings for conflicting/deprecated component attribs (MarkBind#1057) Allow changing parameter properties (MarkBind#1075) Custom timezone for built-in timestamp (MarkBind#1073) Fix reload inconsistency when updating frontmatter (MarkBind#1068) Implement an api to ignore content in certain tags (MarkBind#1047) Enable AppVeyor CI (MarkBind#1040) Add heading and line highlighting to code blocks (MarkBind#1034) Add dividers and fix bug in siteNav (MarkBind#1063) Fixed navbar no longer covers modals (MarkBind#1070) Add copy code-block plugin (MarkBind#1043) Render plugins on dynamic resources (MarkBind#1051) Documentation for Implement no-* attributes for <box> (MarkBind#1042) Migrate to bootstrap-vue popovers (MarkBind#1033) Refactor preprocess and url processing functions (MarkBind#1026) Add pageNav to Using Plugins Page (MarkBind#1062)

* 'master' of https://github.com/MarkBind/markbind: Add example for using multiple features in code-blocks (MarkBind#1102)

* 'master' of https://github.com/MarkBind/markbind: Convert code in boxes to code block (MarkBind#1086)

* 'master' of https://github.com/MarkBind/markbind: Update test files (MarkBind#1138) Remove OK button from modals (MarkBind#1134) Add start from line number functionality to code blocks (MarkBind#1115) Allow special tags to be self-closing (MarkBind#1101) Simplify baseUrl resolving process (MarkBind#1087) Remove redundant file writing (MarkBind#1090) Bump acorn from 5.7.3 to 5.7.4 (MarkBind#1121) Bump acorn from 7.1.0 to 7.1.1 in /src/lib/markbind (MarkBind#1120) Unify markdown-it parser variants (MarkBind#1056) Remove dynamic include feature (MarkBind#1037) Fix flex shrink not applying in content wrapper (MarkBind#1135) Escape Nunjucks for special tags (MarkBind#1049) Update documentation on icon slot for boxes (MarkBind#1123)

* 'master' of https://github.com/MarkBind/markbind: Fix pageNav in tweaking the page structure (MarkBind#1127)

* 'master' of https://github.com/MarkBind/markbind: Fix lazy reload for urls without index (MarkBind#1110) Changes remaining references from filterTags to tags (MarkBind#1149)

yash-chowdhary

LGTM!
Just one nit.

docs/devGuide/devGuide.md

Co-Authored-By: Yash Chowdhary <yashchowdhary98@gmail.com>

Tejas2805 · 2020-03-30T09:12:11Z

@yash-chowdhary Can I get your final review on this?

yash-chowdhary · 2020-03-30T13:34:52Z

LGTM! 🚀

Tejas2805 · 2020-03-31T07:33:43Z

@nbriannl Can I get your review on this?

nbriannl · 2020-03-31T07:35:06Z

All right, on it

nbriannl

Some nit and a factual error.

test\functional contains various test sites.
A test site contains markdown pages.
An example of a test site is test_site, or test_site_algolia_plugin or test_site_expressive_layout or test_site_special_tags etc.. And you can find a list of them in test/functional/test_sites

You either

edit a suitable existing markdown test page within any of the existing tests sites
add a new page to an existing test site (which is what your steps detail)
add a new test site entirely, containing a page which demonstrates the new feature
- and this requires you to update test/functional/test_sites

docs/devGuide/devGuide.md

Co-Authored-By: nbriannl <neilbrian.nl@gmail.com>

ang-zeyu · 2020-04-03T08:41:48Z

docs/devGuide/devGuide.md

+    ....
+```
+
+4. Update the tests.


Update the expected test files using npm run updatetest

ang-zeyu · 2020-04-03T08:43:50Z

docs/devGuide/devGuide.md

+```
+
+4. Update the tests.
+
 <box type="info">
  When creating a new test site, the directory name of the new test site should be added to <code>test/functional/test_sites</code>.


Could remove this as well, we don't have a test_sites directory

It's a file without an extension. Please check again 😅

https://github.com/MarkBind/markbind/tree/master/test/functional/test_sites

Perhaps we should mention that it's a file. Since you (and Tejas and even i) thought it was a directory at first.

Ah my bad. I even added to it at one point ( test_site_special_tags ) 😅

Perhaps we should mention that it's a file. Since you (and Tejas and even i) thought it was a directory at first.

How to mention its a file though?

Something like - When creating a new test site, the directory name of the new test site should be added to test/functional/test_sites file ?

docs/devGuide/devGuide.md

Tejas2805 · 2020-04-07T11:32:16Z

@ang-zeyu @nbriannl Can I get your review on this? Thank you for your time!

nbriannl

LGTM.

* 'master' of https://github.com/MarkBind/markbind: (41 commits) Document adding new site content in DG (MarkBind#1153) Add relative date feature (MarkBind#908) Use <br> to separate lines of code block (MarkBind#1176) Parse popovers for footnotes (MarkBind#1155) Resolve comments Expand test extensions and fix whitespace checks (MarkBind#1156) Address comments Upgrade js-beautify and provide option to turn it off (MarkBind#1116) Normalize inline puml line ending before hashing (MarkBind#1174) Update tests (MarkBind#1178) Remove fixed bugs from test\functional\test_site\bugs\index.md` (MarkBind#1148) Fix bug in Search for UG and DG (MarkBind#1147) Add inline puml support (MarkBind#1100) Fix hrefs for headings with angular brackets (MarkBind#1089) Update tests for 2.13.1 (MarkBind#1169) 2.13.1 Update vue-strap version to v2.0.1-markbind.39 Fix fontawsome icons don't show underlines to indicate modal/tooltip (MarkBind#1133) 2.13.0 Update test files ...

New developers contributing a new feature to MarkBind have a hard time adding new content to the test site. Let's add documentation regarding how to do so.

Tejas2805 added 11 commits February 17, 2020 04:54

add _site to ignore list

538ff88

update highlighted text bg color

52e1afa

Merge branch 'master' of https://github.com/MarkBind/markbind

d86bf69

* 'master' of https://github.com/MarkBind/markbind: Add example for using multiple features in code-blocks (MarkBind#1102)

Merge branch 'master' of https://github.com/MarkBind/markbind

22b2b74

* 'master' of https://github.com/MarkBind/markbind: Convert code in boxes to code block (MarkBind#1086)

Merge branch 'master' of https://github.com/MarkBind/markbind

60a44fa

* 'master' of https://github.com/MarkBind/markbind: Fix pageNav in tweaking the page structure (MarkBind#1127)

Merge branch 'master' of https://github.com/MarkBind/markbind

b9c3646

* 'master' of https://github.com/MarkBind/markbind: Fix lazy reload for urls without index (MarkBind#1110) Changes remaining references from filterTags to tags (MarkBind#1149)

add documentation

8b81b5a

Correct highlighting

0970ee1

yash-chowdhary reviewed Mar 28, 2020

View reviewed changes

docs/devGuide/devGuide.md Outdated Show resolved Hide resolved

Update docs/devGuide/devGuide.md

eadc9ad

Co-Authored-By: Yash Chowdhary <yashchowdhary98@gmail.com>

nbriannl requested changes Mar 31, 2020

View reviewed changes

docs/devGuide/devGuide.md Outdated Show resolved Hide resolved

docs/devGuide/devGuide.md Outdated Show resolved Hide resolved

docs/devGuide/devGuide.md Outdated Show resolved Hide resolved

docs/devGuide/devGuide.md Show resolved Hide resolved

docs/devGuide/devGuide.md Show resolved Hide resolved

Tejas2805 and others added 4 commits March 31, 2020 20:43

Update docs/devGuide/devGuide.md

4d7bc65

Co-Authored-By: nbriannl <neilbrian.nl@gmail.com>

Update docs/devGuide/devGuide.md

b3fe707

Co-Authored-By: nbriannl <neilbrian.nl@gmail.com>

Update docs/devGuide/devGuide.md

7a25926

Co-Authored-By: nbriannl <neilbrian.nl@gmail.com>

update devGuide based on comments

7981227

yash-chowdhary added the pr.DocsUpdate 📃 Pure changes to the documentation, such as typo, restructuring, etc label Apr 1, 2020

Tejas2805 requested a review from nbriannl April 2, 2020 19:32

ang-zeyu reviewed Apr 3, 2020

View reviewed changes

Update devGuide.md

87d0155

Tejas2805 requested review from ang-zeyu and yash-chowdhary April 4, 2020 21:55

nbriannl approved these changes Apr 7, 2020

View reviewed changes

ang-zeyu approved these changes Apr 8, 2020

View reviewed changes

ang-zeyu added this to the v2.13.2 milestone Apr 8, 2020

ang-zeyu merged commit b54b76f into MarkBind:master Apr 8, 2020

marvinchin pushed a commit that referenced this pull request Apr 10, 2020

Document adding new site content in DG (#1153)

9e7a460

New developers contributing a new feature to MarkBind have a hard time adding new content to the test site. Let's add documentation regarding how to do so.

Tejas2805 deleted the testing-documentation branch April 11, 2020 14:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document adding new site content in DG #1153

Document adding new site content in DG #1153

Tejas2805 commented Mar 27, 2020 •

edited

yash-chowdhary left a comment

Tejas2805 commented Mar 30, 2020

yash-chowdhary commented Mar 30, 2020

Tejas2805 commented Mar 31, 2020

nbriannl commented Mar 31, 2020

nbriannl left a comment •

edited

ang-zeyu Apr 3, 2020

ang-zeyu Apr 3, 2020

nbriannl Apr 3, 2020

nbriannl Apr 3, 2020

ang-zeyu Apr 3, 2020

Tejas2805 Apr 3, 2020 •

edited

Tejas2805 commented Apr 7, 2020

nbriannl left a comment

Document adding new site content in DG #1153

Document adding new site content in DG #1153

Conversation

Tejas2805 commented Mar 27, 2020 • edited

yash-chowdhary left a comment

Choose a reason for hiding this comment

Tejas2805 commented Mar 30, 2020

yash-chowdhary commented Mar 30, 2020

Tejas2805 commented Mar 31, 2020

nbriannl commented Mar 31, 2020

nbriannl left a comment • edited

Choose a reason for hiding this comment

ang-zeyu Apr 3, 2020

Choose a reason for hiding this comment

ang-zeyu Apr 3, 2020

Choose a reason for hiding this comment

nbriannl Apr 3, 2020

Choose a reason for hiding this comment

nbriannl Apr 3, 2020

Choose a reason for hiding this comment

ang-zeyu Apr 3, 2020

Choose a reason for hiding this comment

Tejas2805 Apr 3, 2020 • edited

Choose a reason for hiding this comment

Tejas2805 commented Apr 7, 2020

nbriannl left a comment

Choose a reason for hiding this comment

Tejas2805 commented Mar 27, 2020 •

edited

nbriannl left a comment •

edited

Tejas2805 Apr 3, 2020 •

edited