# Notepad for GAP Days Spring 2024

*Beware that the contents of this notepad can be read and modified by anyone with access to the URL, so you should not share any sensitive information here.*

#### Table of contents:

[TOC]

# Topics

## Topic 1: TBA

TODO

## Topic 2: TBA

TODO

# Programme

## Day 1: Monday

### Schedule

- 10:00 Opening of GAPDays
- 10:10 Introduction of everyone and final planning of schedule
- 11:00 Setup session
- 12:00 *Lunch break*
- 13:30 Talk: tbd
- 14:00 Work session: How to work with and contribute to GAP (also possible git crash course)
- Maybe already working on some good first issues
- 15:30 Plan for starting with new package list, especially setting of goals
- 16:30 Stand-up Meeting: Results of first work session and plans for the coming days

### Afternoon stand-up / Results and accomplishments

- Max:
- Discussions on pkg lists
- Helped PhD student
- Helped Claudio with pkg release
- Nusa:
- Working out how to get Jupyter&GAP to talk to each other (trying to write instructions)
- Claudio:
- Worked on CoreFreeSub Pkg, adding functionalities (solvable groups)
- Preparing release
- Ruth:
- working on the GAP website
- investigate switching it to JustTheDocs
- Meike:
- explored the GAP website, found interesting things
- familiarize with its source code
- Lukas:
- looked up <https://datatables.net>
- trying to write a very basic table with it
- Iryna & Maryna:
- work on https://github.com/gap-packages/LocalNR/issues/11
- more LocalNR work

## Day 2: Tuesday

### Schedule

- 9:00 Stand-up Meeting: Distributon of tasks for new package list
- 9:30 Work session: new package list (e.g. mockups, precise planning of functions)
- 11:00 Talk: *How to set up a package website using GitHub and Jekyll* (Max Horn)
- 12:00 *Lunch break*
- 13:20 Group photo
- 13:30 Talk: tbd, Stephen Linton
- 14:00 Work session: transition plan from old website
- 15:30 Plan for implementing results from today
- 16:30 Stand-up Meeting: Results from work sessions

### Morning stand-up

- NAME:
- PLAN 1
- PLAN 2
- NAME:
- PLAN 1
- PLAN 2

### Afternoon stand-up / Results and accomplishments

- NAME:
- RESULT 1
- RESULT 2
- NAME:
- RESULT 1
- RESULT 2

## Day 3: Wednesday

### Schedule

- 9:00 Stand-up Meeting: Distribution of tasks for MVP and implementation
- Work session: MVP for package list
- 12:00 *Lunch break*
- 13:30 Talk: tbd
- 14:00 Work session: turning the MVP into a sustainable system
- 16:30 Stand-up Meeting: Results from new package list
- 19:00 (Conference dinner)

### Morning stand-up

- NAME:
- PLAN 1
- PLAN 2
- NAME:
- PLAN 1
- PLAN 2

### Afternoon stand-up / Results and accomplishments

- NAME:
- RESULT 1
- RESULT 2
- NAME:
- RESULT 1
- RESULT 2

## Day 4: Thursday

### Schedule

- 9:00 Talk: Introduction to group actions in GAP
- 9:30 Stand-up Meeting: Distribution of tasks for permutation actions
- 10:00 Work session: cleaning up permutation actions
- 12:00 *Lunch break*
- 13:30 Talk: tbd
- 14:00 Work session (continued): cleaning up permutation actions
- 16:30 Stand-up Meeting: Results from cleaning up permutation actions

### Morning stand-up

- NAME:
- PLAN 1
- PLAN 2
- NAME:
- PLAN 1
- PLAN 2

### Afternoon stand-up / Results and accomplishments

- NAME:
- RESULT 1
- RESULT 2
- NAME:
- RESULT 1
- RESULT 2

## Day 5: Friday

### Schedule

- 9:00 Stand-up meeting: Remaing tasks to clean finishing of GAPDays
- 9:30 Work session: clean finish of GAPDays
- 12:00 *Lunch break*
- 13:30 Work session: Future GAPDays and feedback
- 15:00 **Closing of GAPDays**

### Morning stand-up

- NAME:
- PLAN 1
- PLAN 2
- NAME:
- PLAN 1
- PLAN 2

### Afternoon stand-up / Results and accomplishments

- NAME:
- RESULT 1
- RESULT 2
- NAME:
- RESULT 1
- RESULT 2

#### Packages list

- prerequisits
- (see <https://github.com/gap-system/GapWWW/blob/master/README.md> for details)
- install Jekyll (Ruby)
- install bundler if not already there (try `which bundle` to see if it is)
- clone GapWWW repository: `git clone https://github.com/gap-system/GapWWW`
- once, do

    bundle config set --local path 'vendor/bundle'
    bundle install

- build it locally, try it in a browser

    bundle exec jekyll serve -l

- current sources for lists of packages
1. list of packages shipped with any GAP release (shown on the primary website)
2. list of packages in the [gap-packages GitHub organization](https://github.com/gap-packages) (shown on <https://gap-packages.github.io>)
3. hard coded list of additional packages at https://github.com/gap-packages/gap-packages.github.io (also shown on <https://gap-packages.github.io>)
4. the set of packages going to be shipped with the next GAP release: <https://github.com/gap-system/PackageDistro>

- for showing the data table, maybe use https://datatables.net

## Ideas / scratch space

#### Some issues people might look into:
- any issue with the ["good first issue" label](https://github.com/gap-system/gap/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
- some other harder but very important issues
- https://github.com/gap-system/gap/issues/4785
- https://github.com/gap-system/gap/issues/4749
- https://github.com/gap-system/gap/issues/4714
- https://github.com/gap-system/gap/issues/5137

#### Permutation action
look into and resolve some of these:
- https://github.com/gap-system/gap/issues/3349
- https://github.com/gap-system/gap/issues/3364
- https://github.com/gap-system/gap/issues/3541
- https://github.com/gap-system/gap/issues/4297
- https://github.com/gap-system/gap/issues/4904
- https://github.com/gap-system/gap/issues/4700

#### Webite and docu related work
- https://github.com/gap-system/gap/issues/4690
- https://github.com/gap-system/GapWWW/issues/272
- overhaul the look of the website?
- overhaul the structure / content of the website?
- clean-est set of instructions to GET STARTED with gap+jupyter:
- pre-requisites: m4 and ZMQ, eg. Ubuntu/Debian/Mint: libzmq3-dev
- getting GAP
https://github.com/carpentries-incubator/gap-lesson/blob/gh-pages/setup.md
(do not forget to run BuildPackages.sh)
- first steps:
https://github.com/carpentries-incubator/gap-lesson/blob/gh-pages/reference.md
- notes on installing GAP JupyterKernel
https://github.com/gap-packages/JupyterKernel
contains a lot of good notes on installation/troubleshooting (check **closed** issues)
- do not forget to set a password for it: jupyter notebook password
- other:
https://www.markdownguide.org/cheat-sheet/
https://jupyter.org/install
https://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/index.html

#### packages list
- the list of packages on the website is confusing
- it is only updated when there is a release
- it thus does not correspond to the actual state of "the package distro"
- there are too many package lists:
- on the main website reflecting the state at the last GAP release
- at https://gap-packages.github.io
- the package distro repository <https://github.com/gap-system/PackageDistro>
- can we change that / do we want to?
- relevant issues <https://github.com/gap-system/GapWWW/issues/265>
- see <https://github.com/gap-system/GapWWW/issues/263>
- perhaps have a single list, listing both distributed packages and other packages, with a clear label
- the refereed packages then could get yet another label
- possibly with info as to when the referreing took place, and for which version
- this would even make it possible to have some package refereed multiple times (even with blurbs: "version 2 of package X is a major upgrade, bla bla")
-
- technical: maybe move package list to subdomain `pkg.gap-system.org` (so that it can be "filled" from a different source than the rest of the website, e.g. from the package distro repository)
- Make list searchable? Especially useful when combined with index that also considers description or mayeb even manual. E.g. user wants to find all packages that deal with specific kinds of group and find all packages that have functionality for it

#### Package related work

- add your package (or any other missing packages) to the list at https://gap-packages.github.io
- polycyclic
- fix IGS issues
- possible merge some old PRs
- make a long overdue release
- Alnuth:
- finish switch to userprefs, see [alnuth#33](https://github.com/gap-packages/alnuth/pull/33)
- finish OSCAR integration, see [alnuth#32](https://github.com/gap-packages/alnuth/pull/32)
- forms:
- improve performance of `BaseChangeHermitian`, `BaseChangeOrthogonalQuadratic` (basic linear algebra), see [forms#54](https://github.com/gap-packages/forms/issues/54)
- ...

#### Improve documentation for creating a package and submitting it for distribution

- multiple steps:
- how to create a package? (point to PackageMaker, example package, ...)
- how to setup a website for a package
- ... at least on GitHUb
- how to set up "continuous integration tests" (and what that means)
- how to make releases
- common pitfalls, e.g.
- it doesn't suffice to point to a `PackageInfo.g` in a git repo
- problems on Windows ...?
- ...
- advanced topics:
- bundling binaries
- adding a kernel extension
- where to keep this: a seperate HOWTO (living where)? A seperate manual? Part of the GAP reference manual? On the website?!?
- some relevant issues
- https://github.com/gap-system/gap/issues/5382
- https://github.com/gap-system/gap/issues/4987
- https://github.com/gap-system/gap/issues/4821

#### Resolving correctness issues with PreImages, PreImagesSet, etc.
- see https://github.com/gap-system/gap/issues/4809
- and https://github.com/gap-system/gap/pull/5073
- ... and a bunch more issues/PR on packages

#### SEO optimization
- Especially for making solved problems show up to users with the same problem

###### other

https://app.gather.town/app/8v9jQV7Yeftv5bz1/GAPDays