Skip to content

Commit 824ac2b

Browse files
GMishxShrutim1505
authored andcommitted
fix: spelling correction
Signed-off-by: Shruti78 <shrutimurthy2103@gmail.com>
1 parent ec1be23 commit 824ac2b

File tree

2 files changed

+49
-1
lines changed

2 files changed

+49
-1
lines changed

content/en/docs/Deployment/Legacy/Deploy-Natively-11.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ description:
88

99
## Introduction
1010

11-
We are covering the update for ubuntu 18.04 LTS here, because that is our main / agreed base system for running sw360. sw360 may run on a varienty of other linux distributions or OSes such as macosx, but in order to avoid problem we agreed on having a reference OS, which are the ubuntu long term releases. The author of this guide also uses macosx and homebrew which also works fairly well.
11+
We are covering the update for Ubuntu 18.04 LTS here because it is our main and agreed-upon base system for running SW360. While SW360 may run on a variety of other Linux distributions or operating systems such as macOS, we have agreed to use Ubuntu Long-Term Releases as a reference OS to avoid compatibility issues. The author of this guide also uses macOS with Homebrew, which works fairly well.
12+
13+
1214

1315
Please note that during the time, the dependencies are updated and the version info might change.
1416

content/en/gsoc/GSoC-projects-2025.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ https://github.com/eclipse-sw360/sw360/discussions/2868
8080
4. [Improve tests for all REST API endpoints](#improve-tests-for-all-rest-api-endpoints)
8181
5. [SBOM based recommendation](#sbom-based-recommendation)
8282
6. [Creating Project as a Service](#creating-project-as-a-service)
83+
7. []
8384

8485
### License Change Detection
8586

@@ -245,4 +246,49 @@ still reusing the common Component repository.
245246
| Skills needed | Java, Spring, Microservices, REST |
246247
| Contact | @keerthi-bl @GMishx @heliocastro |
247248

249+
250+
### Update Official Documentation Page
251+
252+
**Goal:** Separate out the Project and related modules as a separate
253+
microservice
254+
255+
#### Motivation
256+
The current official documentation page (https://eclipse.dev/sw360/) lacks clear
257+
instructions regarding environment configurations and upgrade procedures for
258+
recent software versions. This discrepancy often confuses users and negatively
259+
affects productivity during installation or updating processes. Keeping the
260+
official documentation accurate and up-to-date helps attract new users and
261+
fosters an active user community. Moreover, documentation updates do not require
262+
direct changes to the software source code, allowing contributors to undertake
263+
this task concurrently with other development or testing activities, thus
264+
lowering the barriers for OSS contributions.
265+
266+
### Proposed Changes
267+
- Clearly document environment setup instructions and upgrade procedures
268+
corresponding to the latest software versions.
269+
- Complement missing details in documentation, such as updates to dependencies
270+
and version compatibility, reducing user confusion.
271+
- Enhance visual clarity by adding practical examples and screenshots
272+
illustrating the updated procedures.
273+
274+
### Notes
275+
- This task involves no source code modifications, making it easy to execute
276+
alongside other development tasks or community activities.
277+
- Documentation updates are valuable contributions to OSS projects and serve as
278+
excellent entry points for new contributors.
279+
- It is advisable to explicitly recognize documentation maintenance as a
280+
significant and formally acknowledged form of OSS contribution.
281+
282+
| Category | Rating |
283+
|:-----------------------|:--------------------------------|
284+
| Low Hanging Fruit | *** |
285+
| Risk/Exploratory | * |
286+
| Fun/Peripheral | ** |
287+
| Core Development | * |
288+
| Project Infrastructure | *** |
289+
| Project size | Medium |
290+
| Preferred contributor | Student/professional |
291+
| Skills needed | Markdown, Hugo |
292+
| Contact | @GMishx @heliocastro @KoukiHama |
293+
248294
</div></div></div>

0 commit comments

Comments
 (0)