Request for contrib project: Advanced bookmarks

Hi everyone,

I would like to request a new xwiki-contrib repository and the related JIRA project for Advanced Bookmarks.

Advanced Bookmarks lets each user bookmark pages with a star in the page action bar, organize them in folders, and display a selection of them in a panel.

It also provides a management page and macro, a tab in the user profile, an administration section (configuration, wiki-wide export and import), and listens to page renames and deletions.

The bookmarks are stored in a dedicated Solr core, one document per user.

It targets XWiki 18.0+, does not require programming rights, and comes with unit tests (Java and JavaScript) and Docker functional tests.

  • Proposed repository name: advanced-bookmarks
  • Proposed JIRA project: “Advanced Bookmarks”, key ADVBOOK
  • GitHub id: christophe-nc

The code is ready to be pushed (Maven groupId org.xwiki.contrib.advancedbookmarks, parent org.xwiki.contrib:parent-platform 18.0.0).

Thanks!

Sounds a lot like https://extensions.xwiki.org/xwiki/bin/view/Extension/Favorites%20Application/ (even if the implementation details are probably different).

Hello,

This is definitively the same purpose, but, with extended possibilities.

Here, you can not organize your bookmarks in subgroups and have a dedicated page with all your bookmarks.

You can order groups and bookmarks manually, just drag and drop. You can change category easily and you can select a “top ten” favorites always displayed in a column.

The purpose of this app was to propose a way to handle bookmarks just like your browser would allow you to do.

OK. Anyway Favorites Application is not very active anymore and there is no real rule against competition :slight_smile:

Is that really a strong requirement ? The practice is generally to target the current LTS (so 17.10.x).

I started creating all that:

I would need a bit more from you (in a private message if you prefer):

  • your jira account, to put you as lead (and so that you have enough to create versions and mark them released on jira)
  • the userid/email you want for your account on https://nexus.xwiki.org, for the release

Hi,

Please find here the requested informations :slight_smile:

jira-account : Username:christophe-cn
userid / email wanted on nexus.xwiki.org : christophe-cn / christophe.cn74@gmail.com

You are no lead of the jira project.

Done, you should have received an email to choose your password in theory (let me know in private, here or on Matrix, if there is a problem and I can set a temporary password for you if the email process does not work).

Hi Thomas,

Thanks a lot for all !

Following your remark, Advanced Bookmarks now targets the current LTS: XWiki 17.10.2+ and Java 17. The unit tests and the Docker functional tests pass against 17.10.2.

The code is now pushed to https://github.com/xwiki-contrib/advanced-bookmarks/ (merged with the initial commit). The Jenkinsfile enables the quality, integration-tests and docker profiles, with Sonar.

Two questions before the first release:

  • Is the project already declared on SonarCloud, or should I set sonar = false for now?
  • What are the next steps to release ? :slight_smile:

Thanks!

Hello,

Thx for you work!

Putting sonar=true makes it automatically appear on sonarcloud. See SonarQube Cloud

Making sure the CI passes on it. EDIT: that’s because of the sonarcloud quality gate which fails on the first run. I’ve triggered a new build, which hopefully should work fine.

See https://contrib.xwiki.org/xwiki/bin/view/Main/WebHome#HReleasetheproject otherwise.

The big important step is documentation, which should go under https://www.xwiki.org/xwiki/bin/view/documentation/extensions/ and follow the doc guide: https://dev.xwiki.org/xwiki/bin/view/Community/DocGuide/

If by chance you’re using Claude Code, then it’s very easy as we have a skill to create that doc automatically. See GitHub - xwiki/xwiki-dev-llm: Shared LLM resources for developers · GitHub

Thanks!