Skip to content
This repository has been archived by the owner on Apr 24, 2022. It is now read-only.

Commit

Permalink
Finished setting up navbar
Browse files Browse the repository at this point in the history
  • Loading branch information
@ong6 @kaixin-hc
ong6 authored and kaixin-hc committed Mar 31, 2022
1 parent 7783a47 commit e59f2e9
Show file tree
Hide file tree
Showing 72 changed files with 449 additions and 275 deletions.
19 changes: 6 additions & 13 deletions docs/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,13 @@
<frontmatter>
pageNav: 3
pageNavTitle: "Chapters of This Page"
</frontmatter>

# Contributing to TEAMMATES

Thanks for taking your time to contribute to TEAMMATES!

We welcome contributions from anyone, in particular, students (see [here](https://teammatesv4.appspot.com/web/front/about) for the list of our contributors). One of the main objectives of TEAMMATES is to help students get experience in an OSS production environment. Here are some information that might be useful to would-be contributors.

* [Getting started](#getting-started)
* [Know the product/project](#know-the-productproject)
* [Code of Conduct](#code-of-conduct)
* [How can I contribute?](#how-can-i-contribute)
* [Submitting an issue](#submitting-an-issue)
* [Manual testing](#manual-testing)
* [Submitting a pull request](#submitting-a-pull-request)
* [Contributor orientation guide](#contributor-orientation-guide)
* [Knowledge required](#knowledge-required)
* [Orientation task list](#orientation-task-list)
* [Other resources](#other-resources)
We welcome contributions from anyone, in particular, students (see [here](https://teammatesv4.appspot.com/web/front/about) for the list of our contributors). One o8f the main objectives of TEAMMATES is to help students get experience in an OSS production environment. Here are some information that might be useful to would-be contributors.

## Getting started

Expand Down
5 changes: 5 additions & 0 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
<frontmatter>
pageNav: 3
pageNavTitle: "Chapters of This Page"
</frontmatter>

# Documentation For Developers

Here are some documents important for TEAMMATES developers.
Expand Down
29 changes: 15 additions & 14 deletions docs/_markbind/layouts/default.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,29 +26,30 @@
</div>
<div class="nav-component slim-scroll">
<site-nav>
* [CONTRIBUTING]({{ baseUrl }}/CONTRIBUTING.html)
* [README]({{ baseUrl }}/README.html)
* [Overview]({{ baseUrl }}/overview.html)
* [Contributing]({{ baseUrl }}/CONTRIBUTING.html)
* [Setting Up]({{ baseUrl }}/setting-up.html)
* Workflow :expanded:
* [Development]({{ baseUrl }}/development.html)
* [Coding]({{ baseUrl }}/best-practices/coding.html)
* [Data Migration]({{ baseUrl }}/best-practices/data-migration.html)
* Design :expanded:
* [Ui Design]({{ baseUrl }}/best-practices/ui-design.html)
* [Captcha]({{ baseUrl }}/captcha.html)
* [Development]({{ baseUrl }}/development.html)
* [Process]({{ baseUrl }}/process.html)
* [Design]({{ baseUrl }}/design.html)
* [Emails]({{ baseUrl }}/emails.html)
* [Index]({{ baseUrl }}/index.html)
* [Issues]({{ baseUrl }}/issues.html)
* [Overview]({{ baseUrl }}/overview.html)
* [Process]({{ baseUrl }}/process.html)
* [Search]({{ baseUrl }}/search.html)
* Best Practices :expanded:
* [Coding]({{ baseUrl }}/best-practices/coding.html)
* [Testing]({{ baseUrl }}/best-practices/testing.html)
* [Data Migration]({{ baseUrl }}/best-practices/data-migration.html)
* [Ui Design]({{ baseUrl }}/best-practices/ui-design.html)
* Testing :expanded:
* [Testing Guidelines]({{ baseUrl }}/best-practices/testing.html)
* [End-to-End Testing]({{ baseUrl }}/e2e-testing.html)
* [Performance Testing]({{ baseUrl }}/performance-testing.html)
* [Snapshot Testing]({{ baseUrl }}/snapshot-testing.html)
* [Static Analysis]({{ baseUrl }}/static-analysis.html)
* [Snapshot Testing]({{ baseUrl }}/snapshot-testing.html)
* [Static Analysis]({{ baseUrl }}/static-analysis.html)
* How-to :expanded:
* [Emails]({{ baseUrl }}/emails.html)
* [Captcha]({{ baseUrl }}/captcha.html)
* [Troubleshooting Guide]({{ baseUrl }}/troubleshooting-guide.html)
* [Glossary]({{ baseUrl }}/glossary.html)
</site-nav>
Expand All @@ -70,7 +71,7 @@

<!-- Support MarkBind by including a link to us on your landing page! -->
<div class="text-center">
<small>[Generated by ]</small>
<small>[Generated by {{MarkBind}} on {{timestamp}}]</small>
</div>

</footer>
67 changes: 67 additions & 0 deletions docs/_markbind/logs/markbind-2022-01-15.log
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1285,3 +1285,70 @@ Check https://markbind.org/userGuide/siteConfiguration.html for more information
2022-01-15T06:50:17.332Z - info: Site data built
2022-01-15T06:50:17.332Z - info: Pages rebuilt
2022-01-15T06:50:17.332Z - info: Website regeneration complete! Total build time: 0.566s
2022-01-15T06:57:21.968Z - info: Website generation started at 2:57:21 pm
2022-01-15T06:57:22.040Z - info: Building assets...
2022-01-15T06:57:22.398Z - info: Assets built
2022-01-15T06:57:22.399Z - info: Generating pages...
2022-01-15T06:57:22.463Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/.github/CODE_OF_CONDUCT.html' found in file 'D:\Development\markbind\teammates\docs\CONTRIBUTING.md'
2022-01-15T06:57:22.466Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/LICENSE' found in file 'D:\Development\markbind\teammates\docs\CONTRIBUTING.md'
2022-01-15T06:57:22.473Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/.github/SUPPORT.html' found in file 'D:\Development\markbind\teammates\docs\CONTRIBUTING.md'
2022-01-15T06:57:22.503Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/developerguide.html' found in file 'D:\Development\markbind\teammates\docs\_markbind\layouts\default.md'
2022-01-15T06:57:22.644Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/(../static-analysis/teammates-checkstyle.xml)' found in file 'D:\Development\markbind\teammates\docs\static-analysis.md'
2022-01-15T06:57:22.645Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/static-analysis/teammates-pmd.xml' found in file 'D:\Development\markbind\teammates\docs\static-analysis.md'
2022-01-15T06:57:22.646Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/static-analysis/teammates-pmdMain.xml' found in file 'D:\Development\markbind\teammates\docs\static-analysis.md'
2022-01-15T06:57:22.647Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/static-analysis/teammates-spotbugs.xml' found in file 'D:\Development\markbind\teammates\docs\static-analysis.md'
2022-01-15T06:57:22.648Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/static-analysis/teammates-tslint.yml' found in file 'D:\Development\markbind\teammates\docs\static-analysis.md'
2022-01-15T06:57:22.648Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/static-analysis/teammates-stylelint.yml' found in file 'D:\Development\markbind\teammates\docs\static-analysis.md'
2022-01-15T06:57:22.767Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/solr.sh' found in file 'D:\Development\markbind\teammates\docs\search.md'
2022-01-15T06:57:23.005Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/src/main/java/teammates/common/util/Const.java' found in file 'D:\Development\markbind\teammates\docs\design.md'
2022-01-15T06:57:23.140Z - info: Pages built
2022-01-15T06:57:23.280Z - info: Site data built
2022-01-15T06:57:23.281Z - info: Website generation complete! Total build time: 1.371s
2022-01-15T06:57:23.307Z - info: Serving "D:\Development\markbind\teammates\docs\_site" at http://127.0.0.1:8080
2022-01-15T06:57:23.307Z - info: Press CTRL+C to stop ...
2022-01-15T06:58:30.635Z - info: [2:58:30 pm] Reload for file change: D:\Development\markbind\teammates\docs\site.json
2022-01-15T06:58:30.655Z - info: Rebuilding 1 pages
2022-01-15T06:58:30.706Z - info: Site data built
2022-01-15T06:58:30.706Z - info: Pages rebuilt
2022-01-15T06:58:30.707Z - info: Website regeneration complete! Total build time: 0.053s
2022-01-15T07:01:07.343Z - info: [3:01:07 pm] Reload for file change: D:\Development\markbind\teammates\docs\_markbind\layouts\default.md
2022-01-15T07:01:08.366Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/developerguide.html' found in file 'D:\Development\markbind\teammates\docs\_markbind\layouts\default.md'
2022-01-15T07:01:08.381Z - info: Rebuilding 23 pages
2022-01-15T07:01:08.400Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/.github/CODE_OF_CONDUCT.html' found in file 'D:\Development\markbind\teammates\docs\CONTRIBUTING.md'
2022-01-15T07:01:08.403Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/LICENSE' found in file 'D:\Development\markbind\teammates\docs\CONTRIBUTING.md'
2022-01-15T07:01:08.409Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/.github/SUPPORT.html' found in file 'D:\Development\markbind\teammates\docs\CONTRIBUTING.md'
2022-01-15T07:01:08.505Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/(../static-analysis/teammates-checkstyle.xml)' found in file 'D:\Development\markbind\teammates\docs\static-analysis.md'
2022-01-15T07:01:08.506Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/static-analysis/teammates-pmd.xml' found in file 'D:\Development\markbind\teammates\docs\static-analysis.md'
2022-01-15T07:01:08.507Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/static-analysis/teammates-pmdMain.xml' found in file 'D:\Development\markbind\teammates\docs\static-analysis.md'
2022-01-15T07:01:08.507Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/static-analysis/teammates-spotbugs.xml' found in file 'D:\Development\markbind\teammates\docs\static-analysis.md'
2022-01-15T07:01:08.508Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/static-analysis/teammates-tslint.yml' found in file 'D:\Development\markbind\teammates\docs\static-analysis.md'
2022-01-15T07:01:08.509Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/static-analysis/teammates-stylelint.yml' found in file 'D:\Development\markbind\teammates\docs\static-analysis.md'
2022-01-15T07:01:08.642Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/solr.sh' found in file 'D:\Development\markbind\teammates\docs\search.md'
2022-01-15T07:01:08.903Z - warn: You might have an invalid intra-link! Ignore this warning if it was intended.
'/src/main/java/teammates/common/util/Const.java' found in file 'D:\Development\markbind\teammates\docs\design.md'
2022-01-15T07:01:09.111Z - info: Site data built
2022-01-15T07:01:09.111Z - info: Pages rebuilt
2022-01-15T07:01:09.111Z - info: Website regeneration complete! Total build time: 0.731s
Loading

0 comments on commit e59f2e9

Please sign in to comment.