sciwork / swportal

Portal website for sciwork: https://sciwork.dev/

Sciwork portal

This repository is for the website for the sciwork portal. Check-ins to the repository will be automatically deployed to the website by Netlify.

The website is built by using pelican. The flow for contribution is:

1. Clone the repository
2. Run a local devserver
3. Edit the content
4. File a pull request (PR) against develop branch
5. Resolve discussions in the PR review
6. PR is merged, done

Note

Do NOT file PR against the master branch.

In the working copy root, run the following command for the local devserver:

env SITEURL=http://localhost:8000 make devserver [PORT=8000]

Branch convention

The master branch is deployed to the official website https://sciwork.dev and https://swportal.netlify.app.

The develop branch is deployed to the under development https://develop--swportal.netlify.app.

Other branches are deployed to https://{branch}--swportal.netlify.app. Replace / in the branch name with -.

Pull requests are deployed to https://deploy-preview-{id}--swportal.netlify.app. {id} is the PR ID.

Changes for improvement

To add contents or website features, create a branch named like feature/your-addition.

New blog entries

To add a new blog entry, the branch name should be feature/blog/entry-name.

New event entries

To add a new evnet entry, the branch name should be feature/event/entry-name.

Bugfix

If you want to fix bugs or typographical errors, create a branch named like bugfix/your-fix.

Writing content

Pelican supports writing content in reStructuredText format (with a file ending in .rst) or Markdown syntax (with a file ending in .md, .markdown, .mkd, or .mdown).

Scisprint

To add a new Scisprint event, save the pages into content/pages/sprint/{date:%Y} directory, and the URL should be sprint/{date:%Y}/{slug}.

Generate Sitemap

In order to generate sitemap.xml smoothly, some modifications are necessary:

1. Make sure that env variable SITEURL has existed.
2. Make sure that each .rst has :url: and :save_as: parameters.
3. each time you run pelican content or make html, sitemap.xml will be generated automatically.

swportal's Issues

Update the March sprint page with photos and other records

Add the web page for October sprint

@YenPeiChen07 , could you please help create a web page under https://sciwork.dev/meetup/ for the October sprint?

The format can reference the career panel in May: https://sciwork.dev/sprint/2022/05-nycu-career , and the contents can be taken from the workbook: https://hackmd.io/@sciwork/meetup-2210 . If there are any questions we can discuss here or in the channel.

HeaderID Plugin

Improve SEO (Search Engine Optimization)

Now the sciwork portal isn't showing up on Google search.
I think we should improve SEO (Search Engine Optimization) to reach the top positions on search engines.

Related links:

• https://github.com/getpelican/pelican-plugins/tree/master/sitemap
• https://search.google.com/search-console

Repurpose meetup section for weekly meetings

In the past we use the name "meetup" for irregular meetings like https://sciwork.dev/meetup/2022/10-nycu . Recently the community wanted to organize a series of weekly meetings and found meetup is a suitable name.

This issue is filed to track repurposing the name meetup for the weekly meeting series. We should change the website accordingly. The past "meetup" event should be moved to the "sprint" list. And the meetup list should host information for the new weekly series.

Add new navbar tab for meetup

The sciwork community is planning for a new type of event named "meetup" (see discussions in https://discord.gg/wtEkBQfBtg), and there should be a navbar tab and a list page for it, just like those of "sprint".

The "meetup" tab can be at the left or right of the "sprint" tab.

Correct the title of the CFD workshop

@j8xixo12 and @kuomc , could you please correct the title of the CFD workshop to be "advance CFD software development"? It's written in the workbook. Both portal https://sciwork.dev/workshop/2024/03-workshop and kktix https://sciwork.kktix.cc/events/cfdworkshop-2024-march should be corrected.

Create kktix registration page for April scisprint

Once created, the sciwork web page for April scisprint should include a link to the kktix registration page.

The kktix registration page should include "本活動委託 KKTIX 代理退票退費" as described in https://support.kktix.com/knowledgebase/articles/356418-kktix-代理退票辦法 .

Multi-line list item does not indent correctly

See the blue text in t.he following picture:

For some reason the style sheet does not have the multi-line list item to align well where it should indent.

Add NYCU/nsd meetup series in the tab

@tychuang1211 Could I ask for your help to create a page under the meetup tab (https://sciwork.dev/meetup/) for the NYCU / nsd meetup series?

We can discuss what to be included in the page in this issue.

Add sciwork 2023 conference report

Please add the sciwork 2023 conference report (https://docs.google.com/document/d/1iKvwd9VLiyqjUaeJzk7GkqyKwbC8oCk1qSVrPvjEw1M) to the portal site. It can be made available under the categories https://sciwork.dev/conference/ .

Event View

swportal sprint 20-2

swportal sprint 20-2

Sciwork Portal (swportal) is the future website planned to serve at http://sciwork.dev/, to replace the current "sciwork 2020 conference" web site. The source files are hosted in https://github.com/sciwork/swportal/ (this repository), and this sprint is to kick off the development.

• Date: 1 August 2020
• Time: 14:00 -- 17:00
• Location: Rm203 2F, Science Building 2, NCTU
• Registration page: https://sciwork.kktix.cc/events/swportal20-2
• Discord: https://discord.gg/6MAkFrD

Last sprint: #1

Topics included in the sprint:

• Familiar with the command line operations
• Static website generator (Pelican)

This issue is to track the related information, and will be continuously updated.

(Last updated on 27th July 2020.)

Styles for rst block quote and admonition do not work in HTML

In the HTML, the following rst features do not rendered correctly:

• Admonitions: https://docutils.sourceforge.io/docs/ref/rst/directives.html#admonitions
• Block quote: https://docutils.sourceforge.io/docs/ref/doctree.html#block-quote

When I use the two features, the HTML looks like nothing happens:

Plan for 2023 March scisprint

We will be starting to plan for the March scisprint. Workbook is at https://hackmd.io/@sciwork/scisprint-2303 . This issue is created to keep track of all related checkins.

swportal sprint 20-1

swportal sprint 20-1

Sciwork Portal (swportal) is the future website planned to serve at http://sciwork.dev/, to replace the current "sciwork 2020 conference" web site. The source files are hosted in https://github.com/sciwork/swportal/ (this repository), and this sprint is to kick off the development.

• Date: 11th July 2020
• Time: 14:00 -- 17:00
• Location: Rm203 2F, Science Building 2, NCTU
• Registration page: https://sciwork.kktix.cc/events/scisprint20jul
• Discord: https://discord.gg/6MAkFrD
• Telegram: https://t.me/scisprint20jul

Topics included in the sprint:

• How does the website works?
• DNS System
  • .dev domain
  • HTTP v.s. HTTPs
• Web Server
  • Netlify
• Static Website Generator
  • Tailwind CSS
  • Pelican

Note: https://us02web.zoom.us/j/83281512748?pwd=QTFxMzd1bnUvMTdQcmZCVm9heUU1dz09

This issue is to track the related information, and will be continuously updated.

(Last updated on 11th July 2020.)

Add web page for meetup at NYCU on March 22

Add a page on the sciwork web page for meetup at NYCU on March 22, this web page should at least include agenda of the meetup.

Ordered list of rst is not rendered in a correct way

See the example at #127. A rst ordered list is not rendered correctly:

#. `Intel Xeon Platinum 9282
   <https://en.wikichip.org/wiki/intel/xeon_platinum/9282>`__

   #. 56 cores
   #. 77MB L3 cache memory

#. `AMD EPYC 7H12
   <https://www.amd.com/en/products/cpu/amd-epyc-7h12>`__

   #. 64 cores
   #. 256MB L3 cache memory

Distinguish the coming (next) event and the events that are not yet being worked on

In the sprint page https://sciwork.dev/sprint/ we list the events that have a time to help the community to schedule their time.

But it is not clear what is the event that is happening immediately, and what are the events that have not been in progress.

The presentation of the list may be improved, while it is also about the organization workflow.

Long title is clipped in mobile view

When the page title is long enough, it is clipped by the cover animation, and the red underline location is too low. Not sure what is the best way to fix this ...

Setup Custom Domain

Issue with sending email through Gmail SMTP in pretalx and swportal integration

I am planning to integrate pretalx into swportalfor our event management needs.
However, I have noticed an issue with sending emails through Gmail SMTP as described in the pretalx FAQ.

The root cause for this issue is that Google has decided to phase out support for Less Secure Apps, and Gmail SMTP relies on this mechanism for sending emails.

A possible solution is to switch the mail backend to the Gmail API.

Links to the event reports at Medium

We have event reports published at https://medium.com/sciwork but do not have links from sciwork.dev. Links should be added to the corresponding sprint pages.

Automatically generate weekly meetup mage

To enhance the event preparation workflow, we could begin automatically generating the meetup webpage.

Improve visual typesetting of the sprint schedule

Currently the sprint schedule is a list and the typesetting is not very visually clear. It can use some enhancement.

Update 23 feb sprint page with the after-event contents

We had a successful February sprint and created an album https://www.flickr.com/photos/sciwork/albums/72177720305939446 and a blog https://medium.com/sciwork/scisprint-2023-february-in-taipei-e565f2d19b1a for it. The after-event contents are also great work and should be added to the event page https://sciwork.dev/sprint/2023/02-taipei .

Add GitHub to discord webhoook

I am working on it.

Include the repository URL in the website to attract contribution

We do not write the repository URL in the website (or it's written somewhere hard to notice). I think it will help us get more contribution to the website itself if the repository URL is easily accessible to visitors.

How to inspect or enforce the pelican plugins used for the website?

In the repository, is there a place specifying the pelican plugins used?

I think it's also OK to check in the pelican plugins to the repository as 3rdparty. It will make it easier to make ad hoc changes.

Add page for scisprint 20 sep

This issue tracks the September scisprint page editing.

create env under Windows + Conda

create conda environments: conda create -n env_name

get into the environment: conda activate env_name

install python and the dependencies:

• conda install python=3.7
• conda install -c conda-forge pelican
• conda install markdown

go to the swportal folder you cloned:

• pelican content -s pelicanconf.py
• cd output
• python -m pelican.server

the are some bugs with pelican --autoreload --listen
it will result in OSError: [WinError 87]
ref: getpelican/pelican#2400
so you can only compile website and depoly/publish through the command above now

Sub-optimal preview in facebook messenger

There doesn't seem to be correct preview when the link is in FB messenger. I didn't check that in other IM/social media, though.

Add placeholder pages for Hsinchu scisprint from January to May

We have confirmed the venue of CTC on the following days:

• 1/27 Sat
• 2/24 Sat
• 3/23 Sat
• 4/20 Sat
• 5/18 Sat

Please create the corresponding sprint pages as placeholders. The contents may be marked as TBD (except the time and place).

Paragraph spacing is missing

Remove the spring seminar page or mark it canceled

@kuomc The spring seminar is canceled but the page is still at https://sciwork.dev/sprint/2024/03-kaohsiung-seminar . Could you please consider to remove it or mark it canceled? To avoid confusion, perhaps removing the whole page may be a good option.

Blog page not found

Use https://develop--swportal.netlify.app/blog.html . Page not found.

Sprint page for April

Create the sciwork.dev webpage for scisprint Hsinchu in April

Sprint page for May

Create the sciwork.dev webpage for scisprint Hsinchu in May