apache / incubator-annotator-website

Apache Annotator (Incubating) Website

Apache Annotator (incubating) Website

The site is currently in static HTML hosted out of the content/ directory.

Any pre-generated/rendered content or documentation should be added to additional folders in the root of this repo.

Publishing

The asf-site branch gets published to an Apache HTTPD static hosting environment run by the Apache infrastructure team.

To update the demo, update the submodule (git submodule update --remote), rebuild (yarn build; in this repo, not inside the submodule), and commit the changes it made in content/.

To add documentation add Markdown to the docs/ folder. Further templating and build configuration of the docs/ content can be done in the .eleventy.js file (since it's built with 11ty.dev).

Developing

Requirements

• node >= 10.x
• yarn >= 1.5.1

This website repository contains the main project repository as a git submodule, in order to build its demo without duplicating the code.

Run git submodule init && git submodule update --remote to pull in the submodule.

Run yarn install to install development dependencies.

Run yarn build to build the demo code and docs content (it will overwrite content/demo and content/docs).

Run yarn serve to build the demo and docs as well as serve and watch (with live reload on changes to the src/ directory only).

Note: if you receive a ERR_OSSL_EVP_UNSUPPORTED error, you can resolve this by using the legacy SSL provider: export NODE_OPTIONS=--openssl-legacy-provider

Organizing

We also use the Milestones for this repo on GitHub to track our quarterly board reports.

Web site issues and PRs are still more than welcome, though!

License

Apache License 2.0 (obviously...:wink:)

incubator-annotator-website's Issues

Update `/demo` to use latest release

The demo code in this site repo differs from the demo code that ships in the repository. We could consolidate them, so they match, but we should at least make sure the site's demo uses the latest (released, probably) Apache Annotator code--and maybe state the version in use?

`yarn build` fails due to package path concatenation failure

Looks like a simple string/path concatenation problem (probably upstream in the demo code?):
"Module not found: Error: Can't resolve 'C:\Users\b\dev\apache\incubator-annotator-website\annotator\ packagesdom \src\index.ts' in 'C:\Users\b\dev\apache\incubator-annotator-website\annotator\web\demo'"
(see the bold bit above)

Raw error below...

ERROR in ./demo/index.js
Module not found: Error: Can't resolve 'C:\Users\b\dev\apache\incubator-annotator-website\annotator\packagesdom\src\index.ts' in 'C:\Users\b\dev\apache\incubator-annotator-website\annotator\web\demo'
 @ ./demo/index.js 26:0-273 90:23-53 91:26-59 92:19-49 190:32-46 238:19-39 247:19-36
 @ multi ./demo/index.html ./demo/index.js

ERROR in ../packages/dom/src/text-position/describe.ts
Module not found: Error: Can't resolve 'C:\Users\b\dev\apache\incubator-annotator-website\annotator\packagesselector\src\index.ts' in 'C:\Users\b\d...

Board Report: October 2023

Important unfinished issues list is based on the February 2023 Board Report.

---

Annotator

Annotator provides annotation enabling code for browsers, servers, and
humans.

Annotator has been incubating since 2016-08-30.

Three most important unfinished issues to address before graduating:

1. Incubation issues identified by Whimsy still need addressing.
2. Project activity is very low.
3. Release activity is very low.

Are there any issues that the IPMC or ASF Board need to be aware of?

The project and community has remained quiet through 2023. We are attempting again to revitalize the community by...
a) simplifying build tooling--both for making releases and for use within other projects
b) communicating and coordinating future planning on the mailing list with other contributors (who we hope will "reactivate")
c) working to move the project closer to the needs of higher level Web developers who need "drop-in" annotation help (vs. our current low level "advanced" library only)

How has the community developed since the last report?

Minimal activity on the mailing list.

How has the project developed since the last report?

No code since last board report.

How would you assess the podling's maturity?

Please feel free to add your own commentary.

• Initial setup
• Working towards first release
• Community building
• Nearing graduation
• Other:

Date of last release:

2022-05-05

When were the last committers or PPMC members elected?

2022-08-17

Have your mentors been helpful and responsive?

Mentors have been helpful when engaged directly with questions.

Is the PPMC managing the podling's brand / trademarks?

No known issues.

Signed-off-by:

• (annotator) Nick Kew
  Comments:
• (annotator) Tommaso Teofili
  Comments:
• (annotator) Benjamin Young
  Comments:

IPMC/Shepherd notes:

Board Report: May 2021 (former April 2021)

---

Annotator

Annotator provides annotation enabling code for browsers, servers, and
humans.

Annotator has been incubating since 2016-08-30.

Three most important unfinished issues to address before graduating:

1. Add active contributors
2. Stabilize a release cadence
3. Continue to demonstrate good governance

Are there any issues that the IPMC or ASF Board need to be aware of?

Community building has been very slow and it has been a long time since the project added new committers or PPMC members. After a period of relative inactivity and a conversion of the codebase to TypeScript, the project is long overdue for a second release. The IPMC should expect to see the project vote on a second release before the next board report to demonstrate forward momentum.

How has the community developed since the last report?

There have been some one-off contributions to project documentation and questions raised by people evaluating the project for use, but there have not been sustained contributions or involvement from new folks yet.

How has the project developed since the last report?

The project is now making continuous development packages to make it easier for developers to test upcoming releases. There is now tooling in place for generating API documentation, with plans to integrate the generated documentation into the website. The existing interfaces have all been documented. These efforts are all focused around the current goal of building community by making it easier for developers to become familiar with the project.

How would you assess the podling's maturity?

Please feel free to add your own commentary.

• Initial setup
• Working towards first release
• Community building
• Nearing graduation
• Other:

Date of last release:

2020-07-11

When were the last committers or PPMC members elected?

2018-09-04

Have your mentors been helpful and responsive?

Yes. Mentors have been as available when needed, but the project will reach out to get advice on what else could be done to make the project more accessible to new contributors and to grow the community.

Is the PPMC managing the podling's brand / trademarks?

There are no branding issues that the PPM is aware of.

Signed-off-by:

• (annotator) Nick Kew
  Comments:
• (annotator) Tommaso Teofili
  Comments:
• (annotator) Benjamin Young
  Comments: Apologies for the lack of sign-off last month!

IPMC/Shepherd notes:

Board Report: January 2019

DRAFT of our board report for January 1st, 2019. If you'd like to make revisions, please copy the text below, and submit a revision as a comment on this issue. If you have a better idea for creating these collaboratively, please file a new issue. 😉

Annotator provides annotation enabling code for browsers, servers, and humans.

Annotator has been incubating since 2016-08-30.

Three most important issues to address in the move towards graduation:

 1. Release initial versions
 2. Add active contributors
 3. Demonstrate good governance through voting on process improvements.

Any issues that the Incubator PMC (IPMC) or ASF Board wish/need to be
aware of?

 The last quarter saw the departure of a couple previous mentors (due to their overall
 workloads being too high in general). They have been replaced by two new mentors
 who are getting familiar with Apache Annotator and its needs.


How has the community developed since the last report?

 We remain a small (probably too small) team, and continue to reach out to potential
 contributors--folks who had expressed interest in building the Apache Annotator community
 and code, but who have yet to participate. We will be doing more to encourage more
 involvement in 2019--especially leading up to http://iannotate.org/ (a significant annotation focused
 event).


How has the project developed since the last report?

 Coding and discussion activity have continued to remain at low levels. We will be working
 on setting some achievable targets for features and release in 2019 in hopes of moving that
 needle.


How would you assess the podling's maturity?
Please feel free to add your own commentary.

 [x] Initial setup
 [-] Working towards first release
 [-] Community building
 [ ] Nearing graduation
 [ ] Other:

Date of last release:

 N/A

When were the last committers or PPMC members elected?

 Last committer was added in August. That same committer is now on the PMC as of November.

Signed-off-by:

 [ ](annotator) Nick Kew
    Comments:
 [ ](annotator) Brian McCallister
    Comments:
 [ ](annotator) Daniel Gruno
    Comments:
 [ ](annotator) Jim Jagielski
    Comments:

Make `asf-site` the new `master`?

Right now the default git branch is master. The site, however, is published out of asf-site.

Do we want to:
a) use asf-site as our "prod" style branch (merge master into asf-site when it's "ready")
b) drop master and make asf-site the new default branch (everything else branches out of it)

I personally like option b. best, but a. can work too--as long as we make that clear and work it that way.

Thoughts? @apache/annotator-committers ?

Board report: January 2021

Should go here: https://cwiki.apache.org/confluence/display/INCUBATOR/January2021#annotator

@BigBlueHat @tilgovi could you review, improve, and submit it?

---

Annotator

Annotator provides annotation enabling code for browsers, servers, and
humans.

Annotator has been incubating since 2016-08-30.

Three most important unfinished issues to address before graduating:

1. Communicate clear roadmap
2. Add active contributors
3. Demonstrate good governance through voting on process improvements.

Are there any issues that the IPMC or ASF Board need to be aware of?

None.

How has the community developed since the last report?

Community calls continue. A few new developers have reached out with interest in using and contributing to the project.

How has the project developed since the last report?

Significant code reorganisation has been undertaken to generalise the selector algorithms, such that they could be applied to other document types/representations than the DOM. A performance issue has been resolved after feedback from early adopters.

How would you assess the podling's maturity?

Please feel free to add your own commentary.

• Initial setup
• Working towards first release (i.e. we made our first release)
• Community building
• Nearing graduation
• Other:

Date of last release:

2020-07-11

When were the last committers or PPMC members elected?

2018-09-04

Have your mentors been helpful and responsive?

As for a while only one mentor was active and responsive, Benjamin Young has been added as mentor to facilitate processes.

Is the PPMC managing the podling's brand / trademarks?

Not applicable.

Signed-off-by:

• (annotator) Nick Kew
  Comments:
• (annotator) Tommaso Teofili
  Comments:
• (annotator) Benjamin Young
  Comments:

IPMC/Shepherd notes:

Cleaning up post demo integration

When I run yarn install in the root of the repo it now creations an empty node_modules/ file and an (essentially) empty yarn.lock file:

# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
# yarn lockfile v1

So, how should we clean these up? .gitignore seems like a bad idea for yarn.lock (should we ever need to commit it) and magically deleting them during the yarn install run also seems like it'd throw off future developers.

💭's?

Board Report: October 2018

As written and submitted by @tilgovi. Filing here for posterity, find-ability, and future-referencing/curation.

Annotator provides annotation enabling code for browsers, servers, and
humans.

Annotator has been incubating since 2016-08-30.

Three most important issues to address in the move towards graduation:

  1. Grow the PPMC
  2. Grow community activity
  3. Build collaboration with downstream users

Any issues that the Incubator PMC (IPMC) or ASF Board wish/need to be
aware of?

The project has lost mentors and would invite help from interested mentors.
This report is a return to regular cadence; it reflects only the month of
September.

How has the community developed since the last report?

The PPMC has begun to reach out to the communities of predecessor projects,
communicate their deprecation, and shepherd users towards the ASF home.

How has the project developed since the last report?

Continuous Integration infrastructure has been set up.

How would you assess the podling's maturity?
Please feel free to add your own commentary.

  [X] Initial setup
  [-] Working towards first release
  [-] Community building
  [ ] Nearing graduation
  [ ] Other:

Date of last release:

  N/A

When were the last committers or PPMC members elected?

Last committer was added in August.

Have your mentors been helpful and responsive or are things falling
through the cracks? In the latter case, please list any open issues
that need to be addressed.

Mentors have been helpful and attentive and are working to set
expectations for project development and address recent stagnation.

Board Report: July 2020 (late)

@tilgovi @Treora I'll let y'all take the first crack at revising this issue--feel free to edit this issue directly (or revise and paste as a comment...completely up to you). Happy to review anytime today.

---

Annotator

Annotator provides annotation enabling code for browsers, servers, and
humans.

Annotator has been incubating since 2016-08-30.

Three most important unfinished issues to address before graduating:

1. Communicate a clear roadmap
2. Add active contributors
3. Demonstrate good governance through voting on process improvements.

Are there any issues that the IPMC or ASF Board need to be aware of?

None.

How has the community developed since the last report?

Community calls continue. A few new developers and projects have reached out with interest in using the project. Developing this community is the highest priority of the project right now.

How has the project developed since the last report?

The project has made its first release. In the month since, the community has converted the project to TypeScript, added a DOM/HTML text highlighting capability to the public API, and expanded the automated test suite.

How would you assess the podling's maturity?

Please feel free to add your own commentary.

• Initial setup
• Working towards first release
• Community building
• Nearing graduation
• Other:

Date of last release:

July 11, 2020

When were the last committers or PPMC members elected?

June 6, 1028

Have your mentors been helpful and responsive?

Yes.

Signed-off-by:

• (annotator) Nick Kew
  Comments:
• (annotator) Steve Blackmon
  Comments:
• (annotator) Tommaso Teofili
  Comments:

IPMC/Shepherd notes:

Mailing list widget on home page is broken (pending upstream fix)

Mostly posting this for group awareness. We have a lovely little mailing list post display thing on our home page which used to work great, but the server sand shifted under our feet and it's currently pending some fixed from the infra team: https://issues.apache.org/jira/browse/INFRA-15587

Once that's back up and running that "widget" on our web site will be working again. Just FYI.

Have docs for multiple versions

As a simple solution, we could just put a snapshot /docs/v0.2.0/, and continue editing in /docs/dev/, perhaps?

Board Report: October 2019

Due today: https://lists.apache.org/thread.html/e27528008568c3c10c6865340589ae5b251aac6b647d7dfac4e7181b@%3Cdev.annotator.apache.org%3E

To be submitted by adding it to this page: https://cwiki.apache.org/confluence/display/INCUBATOR/October2019

---

Annotator

Annotator provides annotation enabling code for browsers, servers, and
humans.

Annotator has been incubating since 2016-08-30.

Three most important unfinished issues to address before graduating:

1. Release initial versions (should happen this week!)
2. Increase activity from current committers and community.
3. Demonstrate good governance through voting and learning the Incubator process (some more).

Are there any issues that the IPMC or ASF Board need to be aware of?

None at this time.

How has the community developed since the last report?

Community activity was quiet. However, code is underway for a first release to be ready in the coming week(s) which we hope will increase interest and activity.

How has the project developed since the last report?

Code for a first release is hoped to be available in the coming days with more community members participating in review and critique. Additionally, work in the W3C's ARIA (accessibility) Working Group and on various browser vendor repositories has highlighted new annotation related activity and opportunity for this project. Sadly, we've mostly failed at raising awareness on the list, so the communities "radar" looks quieter than it should...

How would you assess the podling's maturity?

Please feel free to add your own commentary.

• Initial setup
• Working towards first release
• Community building
• Nearing graduation
• Other:

Date of last release:

None yet, but we hope to release before the end of October 2019.

When were the last committers or PPMC members elected?

No new committers nor PPMC members have been added since the last report.

Have your mentors been helpful and responsive?

No check-ins with/from/by mentors in the last 3 months, but we should do one over email within this next quarter.

Signed-off-by:

• (annotator) Nick Kew
  Comments:
• (annotator) Steve Blackmon
  Comments:
• (annotator) Tommaso Teofili
  Comments:

IPMC/Shepherd notes:

---

@apache/annotator-committers please review the above, and suggest edits below. This report will need to be submitted by EOD today (2019-10-02). Thanks!

Board Report: April 2019

Due tomorrow: https://lists.apache.org/thread.html/7b14a304af0b4497d4729243c26bea7b3cd4bc7b19834c35793172d6@%3Cdev.annotator.apache.org%3E

To be submitted by adding it to this page: https://wiki.apache.org/incubator/April2019

Annotator

Annotator provides annotation enabling code for browsers, servers, and humans.

Annotator has been incubating since 2016-08-30.

Three most important unfinished issues to address before graduating:

 1. Release initial versions
 2. Add more active contributors
 3. Community growth in general

Any issues that the Incubator PMC (IPMC) or ASF Board wish/need to be
aware of?

  Community growth for our project has been much slower than expected. We are aiming
  to ship a release and add at least one committer prior to the next board report. We will
  also be discussing the project's scope and future and trying one last time to (re)build the
  interest and community we'd had during the W3C's Web Annotation Working Group days
  (and the time prior when Annotator.js and Open Annotation were in full swing). If there
  is anything else we should too to achieve incubator goals before the next board report,
  please let us know.

How has the community developed since the last report?

  The immediate Apache Annotator community has remained quiet,
  but interest in Web Annotations (and surrounding technology/specs)
  has increased. We hope to tap into some of that new activity in this
  second quarter of 2019. Additionally, we hope to do further community
  outreach in person at the upcoming I Annotate event in May:
  http://iannotate.org/

How has the project developed since the last report?

  Code and community show minimal (if any) progress. The projects focus
  may be too narrow or the audience for our current DOM libraries may be
  too small to achieve frequent activity at this point. We did begin an effort
  to expand the scope of the project slightly to include server-side code
  and Web Annotation Data Model testing, but interest so far has remained
  minimal.

How would you assess the podling's maturity?
Please feel free to add your own commentary.

  [x] Initial setup
  [-] Working towards first release
  [-] Community building
  [ ] Nearing graduation
  [ ] Other:

Date of last release:

  N/A

When were the last committers or PPMC members elected?

   Last committer was added in August. That same committer is now on the PMC as of November.

Have your mentors been helpful and responsive or are things falling
through the cracks? In the latter case, please list any open issues
that need to be addressed.

  We did welcome our two new mentors, but have not had follow-up
  conversations as a community to (re)focus the group since then. We
  hope to change that in the coming weeks as we look toward promoting
  the project again at the upcoming I Annotate 2019 conference.

Signed-off-by:

  [ ](annotator) Nick Kew
     Comments:
  [ ](annotator) Steve Blackmon
     Comments:
  [ ](annotator) Tommaso Teofili
     Comments:

IPMC/Shepherd notes:

@apache/annotator-committers would love your 👍's (or other) on the above. It's due tomorrow.

Thanks!
🎩

Make full demo for “Getting Started”

Perhaps as its own repo, to give a full example (including any build tools), that people could also just copy and start from.

Board Report: February 2020

We submitted our January 2020 Board Report late...
https://cwiki.apache.org/confluence/display/INCUBATOR/February2020#annotator

Recording here for posterity.

Board Report: April 2020

Due today...

---

Annotator

Annotator provides annotation enabling code for browsers, servers, and
humans.

Annotator has been incubating since 2016-08-30.

Three most important unfinished issues to address before graduating:

1. Release initial versions
2. Add active contributors
3. Demonstrate good governance through voting on process improvements.

Are there any issues that the IPMC or ASF Board need to be aware of?

Not at this time.

How has the community developed since the last report?

We have had increased mentor activity and increased participation on our
weekly calls which have both helped improve our momentum.

How has the project developed since the last report?

We walked through the process of cutting a release (0.1.0) and putting that
release up for a vote. The first vote attempt failed due to a process mistake--we
sent it to general@ before we passed it to dev@. We then attempted a second
vote which passed at the project level, but failed when sent to the Incubator list.
However, we received valuable feedback from Justin Mclean which we are now
acting upon. We plan to attempt another release and vote early this month.

How would you assess the podling's maturity?

Please feel free to add your own commentary.

• Initial setup
• Working towards first release
• Community building
• Nearing graduation
• Other:

Date of last release:

None yet (due to issues with release process and/or voting), but hopefully early
this month.

When were the last committers or PPMC members elected?

No new committers nor PPMC members have been added since the last report.

Have your mentors been helpful and responsive?

Nick Kew has been more involved over email and has also been
in attendance to at least one of the weekly community calls. We have greatly
appreciated the involvement and look forward to more!

Signed-off-by:

• (annotator) Nick Kew
  Comments:
• (annotator) Steve Blackmon
  Comments:
• (annotator) Tommaso Teofili
  Comments:

IPMC/Shepherd notes:

Board Report: April 2024

---

Annotator

Annotator provides annotation enabling code for browsers, servers, and
humans.

Annotator has been incubating since 2016-08-30.

Three most important unfinished issues to address before graduating:

1. Apache Annotator is unable to produce releases due to low activity
2. PMC is largely inactive
3. Motivation to contribute is low due to inability of producing enough release votes

Are there any issues that the IPMC or ASF Board need to be aware of?

See above. Unless there is interest by new people to join the project and help getting out releases, IMHO it would make more sense to retire the podling, fork it and release it without the three-vote hurdle.

How has the community developed since the last report?

The community has not grown.

How has the project developed since the last report?

Yarn has been dropped from the project in favor of npm. Since then, a number of dependabot issues have piled up.

How would you assess the podling's maturity?

Please feel free to add your own commentary.

• Initial setup
• Working towards first release
• Community building
• Nearing graduation
• Other: it is so stable that it is probably ready for retirement ;)

Date of last release:

2021-07-14 (0.2.0)

We tried to get out a 0.3.0 in May 2022, but it got stuck in the vote.

When were the last committers or PPMC members elected?

@reckart was the last one to join in August 2022 (waving the flag).

Have your mentors been helpful and responsive?

@BigBlueHat has prepared the last incubator report for this project and has provided some guidance.

Is the PPMC managing the podling's brand / trademarks?

Are 3rd parties respecting and correctly using the podlings
name and brand? If not what actions has the PPMC taken to
correct this? Has the VP, Brand approved the project name?

I don't know.

Signed-off-by:

• (annotator) Nick Kew
  Comments:
• (annotator) Tommaso Teofili
  Comments:
• (annotator) Benjamin Young
  Comments:

IPMC/Shepherd notes:

DOAP file has an error

The DOAP file as referenced by https://svn.apache.org/repos/asf/comdev/projects.apache.org/trunk/data/projects.xml is found at https://annotator.apache.org/doap.rdf does not parse correctly.

The error returned is:
[line: 38, col: 88] {W002} http://[email protected]:apache/incubator-annotator.git Code: 0/ILLEGAL_CHARACTER in PORT: The character violates the grammar rules for URIs/IRIs.

Add new Apache Annotator logo to site

https://www.apache.org/logos/#annotator

Board Report: July 2019

Putting this issue in place now, so we have this as a more visible deadline at the issues level.

Below is just the template (for now).

Annotator provides annotation enabling code for browsers, servers, and humans.

Annotator has been incubating since 2016-08-30.

Three most important issues to address in the move towards graduation:

 1. Release initial versions
 2. Add active contributors
 3. Demonstrate good governance through voting on process improvements.

Any issues that the Incubator PMC (IPMC) or ASF Board wish/need to be
aware of?

 ...replace with answer...


How has the community developed since the last report?

 ...replace with answer...


How has the project developed since the last report?

 ...replace with answer...


How would you assess the podling's maturity?
Please feel free to add your own commentary.

 [ ] Initial setup
 [ ] Working towards first release
 [ ] Community building
 [ ] Nearing graduation
 [ ] Other:

Date of last release:

 ...replace with answer...

When were the last committers or PPMC members elected?

 ...replace with answer...

Signed-off-by:

  [ ](annotator) Nick Kew
     Comments:
  [ ](annotator) Steve Blackmon
     Comments:
  [ ](annotator) Tommaso Teofili
     Comments: