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

MarkBind Template for CS2103/Software Documentation #2384 #2396

Closed

Conversation

KevinEyo1
Copy link
Contributor

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • DevOps
  • Improve developer experience
  • Others, please explain:

Overview of changes:
Resolves #2384
Added necessary files from ab3 repo to template folder.
Added deployed netlify site for ab3 template to templates.md file in UG docs.

Anything you'd like to highlight/discuss:
Currently deployed site on templates.md is hosted on personal github repo and account.

Testing instructions:

markbind init --template ab3

Proposed commit message: (wrap lines at 72 characters)
A template for CS2103 students to use for their team project
would incentivise users to use MarkBind over the default option
as there is something for users to start with that is catered to
this specific use case.

Let's add ab3 as an option when initialising markbind template.


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

Reviewer checklist:

Indicate the SEMVER impact of the PR:

  • Major (when you make incompatible API changes)
  • Minor (when you add functionality in a backward compatible manner)
  • Patch (when you make backward compatible bug fixes)

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

  • To be included in the release note for any feature that is made obsolete/breaking

Give a brief explanation note about:

  • what was the old feature that was made obsolete
  • any replacement feature (if any), and
  • how the author should modify his website to migrate from the old feature to the replacement feature (if possible).

Copy link

codecov bot commented Jan 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f9d27fc) 48.87% compared to head (ef96316) 48.87%.
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2396   +/-   ##
=======================================
  Coverage   48.87%   48.87%           
=======================================
  Files         124      124           
  Lines        5238     5238           
  Branches     1109     1109           
=======================================
  Hits         2560     2560           
  Misses       2371     2371           
  Partials      307      307           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@damithc
Copy link
Contributor

damithc commented Jan 28, 2024

@KevinEyo1 Hold on first. Sorry I didn't spot this earlier but I don't think we need to do this. Providing help for using MarkBind in AB3 is already taken care of. The only thing missing is AB3-specific instructions for setting up Netlify, which I'm not that keen on anyway. We can discuss further F2F on Monday.

@KevinEyo1 KevinEyo1 marked this pull request as ready for review January 28, 2024 10:02
@lhw-1 lhw-1 marked this pull request as draft January 28, 2024 13:58
@tlylt
Copy link
Contributor

tlylt commented Jan 29, 2024

@KevinEyo1 Hold on first. Sorry I didn't spot this earlier but I don't think we need to do this. Providing help for using MarkBind in AB3 is already taken care of. The only thing missing is AB3-specific instructions for setting up Netlify, which I'm not that keen on anyway. We can discuss further F2F on Monday.

My original understanding is that we are going to create a simplified version of ab3 retaining its structure of about-us, UG, DG etc, such that users (potentially 2103 students) can reuse this template for a fresh project if they want.

@damithc
Copy link
Contributor

damithc commented Jan 29, 2024

My original understanding is that we are going to create a simplified version of ab3 retaining its structure of about-us, UG, DG etc, such that users (potentially 2103 students) can reuse this template for a fresh project if they want.

@tlylt I see. In that case it should be a generic project documentation template, with no reference to AB3. For example, the template name should not be ab3.

@KevinEyo1 KevinEyo1 closed this Feb 4, 2024
@KevinEyo1 KevinEyo1 deleted the 2384-markbind-template-ab3 branch February 4, 2024 08:05
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.

MarkBind Template for CS2103/Software Documentation
3 participants