UCL / UCL/open-source

Improve the welcome text with an executive summary

Open
#40 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement website
Dominant language
HTML
Stars
9
Forks
8
Avg merge
3d 13h
Merged PRs (30d)
4

Description

The front page of the Library Office for Open Science and Scholarship has a very "executive" summary then a bit more detail...

Image

I think we should aim for something similar. That is: a single executive summary sentence what is open source at UCL then a bit of a longer explanation.

What is there at the moment feels like it could be improved (punchier, clearer ?)

What does UCL do to promote Open Source (Software, Data, Hardware, Educational Resources, Science, …)? In these pages you’ll find our efforts to find that out.

Many of us are from UCL’s Advanced Research Computing Centre (ARC), but we are not alone. Check our about page to find out who we are. From within ARC we are leading the efforts to build an Open Source Programme Office in UCL.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Inspect the repository's front page and locate the existing welcome text quoted in the issue. Revise it to begin with a single executive-summary sentence about open source at UCL, followed by a clearer, more detailed explanation. It is done when the front-page wording matches that structure and is more direct.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
content, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.