TrueCloudLab/frostfs.info
6
0
Fork 3
Code Issues 10 Pull requests Projects Activity Actions

Add required sections to the website #30

Merged
potyarkin_admin merged 4 commits from potyarkin/frostfs.info:feature/add-content into master 2025-02-28 14:49:42 +00:00
Conversation 0 Commits 4 Files changed 8 +269 -6
potyarkin commented 2025-02-18 11:55:37 +00:00
Member
Copy link

Our website is pretty barebones at the moment. In this PR I'm adding some common sense pages/sections that are also required by FLOSS Best Practices badge:

There are still some entries from FLOSS BPC checklist that could be ticked off by writing on the website (documentation_basics, vulnerability_report_private) but let's leave those for separate PR(s).

Our website is pretty barebones at the moment. In this PR I'm adding some common sense pages/sections that are also required by [FLOSS Best Practices](https://git.frostfs.info/TrueCloudLab/-/projects/8) badge: - [x] [description_good](https://www.bestpractices.dev/en/criteria/0?details=true&rationale=true#0.description_good) - [x] [interact](https://www.bestpractices.dev/en/criteria/0?details=true&rationale=true#0.interact) - [x] [contribution](https://www.bestpractices.dev/en/criteria/0?details=true&rationale=true#0.contribution) - [x] [contribution_requirements](https://www.bestpractices.dev/en/criteria/0?details=true&rationale=true#0.contribution_requirements) - [x] [report_process](https://www.bestpractices.dev/en/criteria/0?details=true&rationale=true#0.report_process) - [x] [vulnerability_report_process](https://www.bestpractices.dev/en/criteria/0?details=true&rationale=true#0.vulnerability_report_process) - [x] [documentation_interface](https://www.bestpractices.dev/en/criteria/0?details=true&rationale=true#0.documentation_interface) There are still some entries from FLOSS BPC checklist that could be ticked off by writing on the website ([documentation_basics], [vulnerability_report_private]) but let's leave those for separate PR(s). [documentation_basics]: https://www.bestpractices.dev/en/criteria/0?details=true&rationale=true#0.documentation_basics [vulnerability_report_private]: https://www.bestpractices.dev/en/criteria/0?details=true&rationale=true#0.vulnerability_report_private
potyarkin self-assigned this 2025-02-18 11:55:37 +00:00
potyarkin added 1 commit 2025-02-18 11:55:37 +00:00
[#22] Add FrostFS description to the site
All checks were successful
build static site / build (pull_request) Successful in 55s
Details
727a5f7b88 
Besides the fact that's it's required by common sense, having project
description also checks the mark for the FLOSS Best Practises badge:

[description_good]: https://www.bestpractices.dev/en/criteria/0#0.description_good

(close #22)

Signed-off-by: Vitaliy Potyarkin <v.potyarkin@yadro.com>
potyarkin added this to the FLOSS Best Practices Criteria (Passing) project 2025-02-18 11:55:42 +00:00
potyarkin added 1 commit 2025-02-18 14:08:15 +00:00
[#23] List primary communication channels
All checks were successful
build static site / build (pull_request) Successful in 23s
Details
c6c5e2a5f1 
[interact]: https://www.bestpractices.dev/en/criteria/0?details=true&rationale=true#0.interact

Signed-off-by: Vitaliy Potyarkin <v.potyarkin@yadro.com>
potyarkin force-pushed feature/add-content from c6c5e2a5f1 to ce2754a711 2025-02-18 14:09:00 +00:00 Compare
potyarkin force-pushed feature/add-content from ce2754a711 to 87a621b460 2025-02-18 14:21:47 +00:00 Compare
potyarkin force-pushed feature/add-content from 87a621b460 to a7ec53c56f 2025-02-18 14:23:24 +00:00 Compare
potyarkin added 1 commit 2025-02-18 15:34:13 +00:00
[#18] Add contribution guide
All checks were successful
build static site / build (pull_request) Successful in 24s
Details
f3111ce66f 
[contribution]: https://www.bestpractices.dev/en/criteria/0?details=true&rationale=true#0.contribution
[contribution_requirements]: https://www.bestpractices.dev/en/criteria/0?details=true&rationale=true#0.contribution_requirements

Signed-off-by: Vitaliy Potyarkin <v.potyarkin@yadro.com>
potyarkin force-pushed feature/add-content from f3111ce66f to ff43e162f4 2025-02-27 12:42:52 +00:00 Compare
potyarkin added 1 commit 2025-02-27 12:57:19 +00:00
[#30] Add links to API documentation
All checks were successful
build static site / build (pull_request) Successful in 13s
Details
build static site / build (push) Successful in 27s
Details
c323ebe727 
[documentation_interface]: https://www.bestpractices.dev/en/criteria/0?details=true&rationale=true#0.documentation_interface

Signed-off-by: Vitaliy Potyarkin <v.potyarkin@yadro.com>
potyarkin changed title from WIP: Add required sections to the website to Add required sections to the website 2025-02-27 13:08:46 +00:00
requested review from realloc 2025-02-27 13:08:56 +00:00
potyarkin_admin merged commit c323ebe727 into master 2025-02-28 14:49:42 +00:00
potyarkin_admin deleted branch feature/add-content 2025-02-28 14:49:43 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
realloc
Labels
Clear labels   
FEP

FrostFS Enhancement Proposal

  
P0

Highest

  
P1

High

  
P2

Medium

  
P3

Low

  
good first issue

Good for newcomers

  
theme

Hugo theme and visual elements

  
yaczrokh

YADRO

  
Infrastructure

Infrastructure, Automation, CI/CD or DevOps related stuff

  
blocked

The issue or PR is blocked by something

  
bug

Something is not working

  
config

Configuration format update or breaking change

  
discussion

Talking about something in order to reach a decision or to exchange ideas

  
documentation

Documentation related

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
go

Language features adoption

  
help wanted

Extra attention is needed

  
internal

   
invalid

Something is wrong

  
kludge

This is a kludge and we know it

  
observability

Related to metrics, tracing and logs

  
perfomance

Perfomance related

  
question

More information is needed

  
refactoring

Refactoring

  
wontfix

This won't be fixed

No labels
FEP
P0
P1
P2
P3
good first issue
theme
yaczrokh
Infrastructure
blocked
bug
config
discussion
documentation
duplicate
enhancement
go
help wanted
internal
invalid
kludge
observability
perfomance
question
refactoring
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
FLOSS Best Practices Criteria (Passing)
Assignees
Clear assignees
No assignees
potyarkin
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: TrueCloudLab/frostfs.info#30
No description provided.
Delete branch "potyarkin/frostfs.info:feature/add-content"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?