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

Include link to the migrated AB3 website on our showcase #2517

Merged
merged 2 commits into from
Apr 15, 2024

Conversation

tlylt
Copy link
Contributor

@tlylt tlylt commented Apr 13, 2024

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:
Fixes #2072

Anything you'd like to highlight/discuss:
If the AB3 website is defaulted to use MarkBind in the future, we should update this link.

Testing instructions:
https://deploy-preview-2517--markbind-master.netlify.app/showcase

Proposed commit message: (wrap lines at 72 characters)
Include link to the migrated AB3 website on our showcase


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
Contributor

@kaixin-hc kaixin-hc left a comment

Choose a reason for hiding this comment

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

Sure, LGTM

I think one thing to consider is there seems to be a (visual only) bug on this website haha

Screenshot 2024-04-13 at 5 36 59 PM Some pages don't update the navbar

It is also a little strange that the subsite embedded/linked in se-education.org is https://se-education.org/addressbook-level3/

@tlylt
Copy link
Contributor Author

tlylt commented Apr 13, 2024

I think one thing to consider is there seems to be a (visual only) bug on this website haha

Interesting & keen observations @kaixin-hc 👀

There are two cases here because the sidebar content for UG and DG are different. For UG the sidebar items are actually different pages, for DG they are anchor links to the same DG page.

(a) for User Guide of the ab3-m website

  • MarkBind UG seems to use the fact that the pages are under the UG folder, hence on MarkBind UG you can click on one of the sub item and UG in navbar will be highlighted
  • Not sure if this is a bug -> maybe it's a feature that we should support

(b) for DG of the ab3-m website


It is also a little strange that the subsite embedded/linked in se-education.org is se-education.org/addressbook-level3

The current default is the Jekyll version so it should be the one linked in se-education.org. The MarkBind version is an alternative, there's a guide in the se-edu here and instructions given to students here
image

@kaixin-hc
Copy link
Contributor

@KevinEyo1 fixed a similar bug recently on #2396 , maybe you can weigh in?


I think you sent the wrong link for instructions to students? But okay, makes sense then to have both websites to show people two alternatives.

@KevinEyo1
Copy link
Contributor

Hi, I did fix this bug on #2400. I just moved the relevant files under a new directory so that it can accurately track the right tab

Navbar:
image

Shifting of files under new directory:
image

@tlylt
Copy link
Contributor Author

tlylt commented Apr 15, 2024

Hi, I did fix this bug on #2400. I just moved the relevant files under a new directory so that it can accurately track the right tab

Navbar:

image

Shifting of files under new directory:

image

I see... in that case it's not a bug:) it depends on how users arrange their files

@tlylt tlylt merged commit 48888ce into MarkBind:master Apr 15, 2024
7 of 8 checks passed
@github-actions github-actions bot added the r.Patch Version resolver: increment by 0.0.1 label Apr 15, 2024
@tlylt tlylt deleted the add-link branch April 15, 2024 12:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
r.Patch Version resolver: increment by 0.0.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CS2103T tP docs migration tracker
3 participants