Skip to content

Commit b1ee620

Browse files
nabobalisnabobalis
authored
Merge pull request #53 from numfocus/docs
2 parents b4f041d + cedda8a commit b1ee620

File tree

18 files changed

+449
-108
lines changed

18 files changed

+449
-108
lines changed

.github/workflows/assigment.yml renamed to .github/workflows/issue_assignment.yml

File renamed without changes.

.github/workflows/run_and_deploy.yml renamed to .github/workflows/test_and_deploy.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Run and Deploy
1+
name: Test and Deploy
22

33
on:
44
push:
@@ -18,10 +18,10 @@ jobs:
1818
steps:
1919
- name: Checkout Repository
2020
uses: actions/checkout@v4
21-
- name: Set up Python 3.12
21+
- name: Set up Python 3.13
2222
uses: actions/setup-python@v5
2323
with:
24-
python-version: "3.12"
24+
python-version: "3.13"
2525
- name: Install dependencies
2626
run: |
2727
python -m pip install tox
@@ -34,10 +34,10 @@ jobs:
3434
steps:
3535
- name: Checkout Repository
3636
uses: actions/checkout@v4
37-
- name: Set up Python 3.12
37+
- name: Set up Python 3.13
3838
uses: actions/setup-python@v5
3939
with:
40-
python-version: "3.12"
40+
python-version: "3.13"
4141
- name: Install dependencies
4242
run: |
4343
python -m pip install tox
@@ -52,7 +52,7 @@ jobs:
5252
/home/runner/work/infrastructure/infrastructure/docs/_build/html/*
5353
5454
deploy:
55-
needs: [build_docs]
55+
needs: [check_style, build_docs]
5656
if: |
5757
(
5858
github.event_name != 'pull_request' && (

‎.pre-commit-config.yaml‎

Lines changed: 12 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,17 @@
11
repos:
2-
- repo: https://github.com/myint/docformatter
3-
rev: v1.7.5
2+
- repo: https://github.com/PyCQA/docformatter
3+
rev: eb1df347edd128b30cd3368dddc3aa65edcfac38
44
hooks:
55
- id: docformatter
66
args: [--in-place, --pre-summary-newline, --make-summary-multi]
7-
- repo: https://github.com/myint/autoflake
8-
rev: v2.3.1
9-
hooks:
10-
- id: autoflake
11-
args:
12-
[
13-
"--in-place",
14-
"--remove-all-unused-imports",
15-
"--remove-unused-variable",
16-
]
177
- repo: https://github.com/charliermarsh/ruff-pre-commit
18-
rev: "v0.6.1"
8+
rev: "v0.9.4"
199
hooks:
2010
- id: ruff
21-
args: ["--fix"]
22-
- repo: https://github.com/psf/black
23-
rev: 24.8.0
24-
hooks:
25-
- id: black
26-
- repo: https://github.com/PyCQA/isort
27-
rev: 5.13.2
28-
hooks:
29-
- id: isort
11+
args: ["--fix", "--unsafe-fixes"]
12+
- id: ruff-format
3013
- repo: https://github.com/pre-commit/pre-commit-hooks
31-
rev: v4.6.0
14+
rev: v5.0.0
3215
hooks:
3316
- id: check-ast
3417
- id: check-case-conflict
@@ -37,13 +20,11 @@ repos:
3720
- id: end-of-file-fixer
3821
- id: check-yaml
3922
- id: debug-statements
40-
- repo: https://github.com/codespell-project/codespell
41-
rev: v2.3.0
42-
hooks:
43-
- id: codespell
44-
additional_dependencies:
45-
- tomli
46-
- repo: https://github.com/pre-commit/mirrors-prettier
47-
rev: v4.0.0-alpha.8
23+
- repo: https://github.com/JoC0de/pre-commit-prettier
24+
rev: v3.4.2
4825
hooks:
4926
- id: prettier
27+
- repo: https://github.com/crate-ci/typos
28+
rev: typos-dict-v0.12.4
29+
hooks:
30+
- id: typos

‎_typos.toml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
default.extend-ignore-identifiers-re = [
2+
"alog",
3+
]

‎docs/charter.rst‎

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
****************************************
2-
Project Infrastructure Committee Charter
3-
****************************************
1+
*****************
2+
Committee Charter
3+
*****************
44

5-
The Project Infrastructure Committee is established under Article 5, Sections 1-2 of the NumFOCUS Bylaws.
5+
The Infrastructure Committee is established under Article 5, Sections 1-2 of the NumFOCUS Bylaws.
66

77
Purpose
88
=======
@@ -12,19 +12,21 @@ Digital infrastructure includes but is not limited to:
1212

1313
- Cloud accounts and credits
1414
- Domain registrations and hosting
15+
- Conference management software
16+
- CI/CD documentation and best practices
1517

1618
Mission
1719
=======
1820

19-
The Project Infrastructure Committee will manage project digital infrastructure in a way that is fair, equitable, and supports long-term sustainability and project development.
21+
The Infrastructure Committee will manage project digital infrastructure in a way that is fair, equitable, and supports long-term sustainability and project development.
2022

2123
The Committee will:
2224

2325
- Advise NF staff infrastructure team on how to administer account credentials and access
2426
- Make ongoing recommendations to improve and enhance available infrastructure
2527
- Act as a liaison between sponsored projects and the NF Infrastructure Staff, (who works with vendors)
2628
- Have a representative at monthly project meetings
27-
- Triage new request, e.g. is a request a common need or one off
29+
- Triage new request, e.g., is a request a common need or one off?
2830
- Present best practices from various projects
2931
- Review its charter annually and recommend changes to the board for review
3032

@@ -44,7 +46,7 @@ Membership will reflect the NumFOCUS Diversity Statement by welcoming and encour
4446
The committee will consist of at least 5 members from NumFOCUS at-large community, with the following constraints:
4547

4648
- 1 member is a project contributor to a NumFOCUS sponsored project
47-
- No 2 members are related in employment or NumFOCUS project leadership committee
49+
- No more than 2 members are related in employment or NumFOCUS project leadership committee
4850
- 1 member is a NumFOCUS Staff member
4951

5052
Officers
@@ -63,9 +65,9 @@ The secretary will be elected by the committee's members.
6365
Terms
6466
^^^^^
6567

66-
Committee members will serve a one-year term, at which time they will have the option for unlimited renewals.
67-
The Vice President will serve a one-year term with the option to renew for one additional term.
68-
The Secretary will serve a one-year term with the option to renew for one additional term.
68+
Committee members will serve a two-year term, at which time they will have the option for unlimited renewals.
69+
The Vice President will serve a two-year term with the option to renew for one additional term.
70+
The Secretary will serve a two-year term with the option to renew for one additional term.
6971

7072
Meetings
7173
========
@@ -78,15 +80,4 @@ Record Keeping and Reporting
7880

7981
All committee records will be kept in https://github.com/numfocus/infrastructure
8082

81-
A report on the state of project digital infrastructure including all committee actions will be submitted to the board of directors quarterly on or before the 15th of March, June, September, and December.
82-
83-
Officers and Members
84-
====================
85-
86-
2023-2024 Term
87-
---------------
88-
89-
* Vice-President: Andy R. Terrel
90-
* Secretary: Nabil Freij
91-
* Members: Katrina Riehl, Irfan Alibay, Mridul Seth,
92-
* Observing Members: Nicole Foster, Matt Moore, Arliss Collins
83+
A annual report on the state of project digital infrastructure including all committee actions will be submitted to the board of directors before the 15th of January.

‎docs/ci_cd_guide/index.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
******************************
2-
Paying for CI/CD with numFOCUS
3-
******************************
1+
****************
2+
Paying for CI/CD
3+
****************
44

5-
This guide is intended to help you set up a CI/CD pipeline for your project and get it paid for by numFOCUS.
5+
This guide is intended to help you set up a CI/CD pipeline for your project and get it paid for by NumFOCUS.
66

77
**WIP**
88

‎docs/conf.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
from datetime import datetime
22

3-
author = "numFOCUS Infrastructure Committee"
4-
project = "numFOCUS Project Infrastructure"
3+
author = "NumFOCUS Infrastructure Committee"
4+
project = "NumFOCUS Infrastructure Committee"
55
release = ""
66
copyright = f"{datetime.now().year}, {author}" # NOQA: A001 DTZ005
77
html_theme = "pydata_sphinx_theme"
@@ -11,8 +11,8 @@
1111
html_favicon = "_static/NumFocus_LRG.png"
1212
html_theme_options = {
1313
"logo": {
14-
"text": "Project Infrastructure",
14+
"text": "Infrastructure",
1515
"image_light": "_static/NumFocus_LRG.png", # For light mode
16-
"image_dark": "_static/NumFocus_LRG.png", # For dark mode
17-
}
16+
"image_dark": "_static/NumFocus_LRG.png", # For dark mode
17+
},
1818
}

‎docs/index.rst‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
1-
===============================
2-
numFOCUS Project Infrastructure
3-
===============================
1+
=================================
2+
NumFOCUS Infrastructure Committee
3+
=================================
4+
5+
This site details the activities and governance of the NumFOCUS Infrastructure Committee.
6+
7+
The Committee is "responsible for managing project digital infrastructure in a way that is fair, equitable, and supports long-term sustainability and project development."
8+
9+
We also advice the NumFOCUS staff on infrastructure-related matters.
410

511
.. toctree::
612
:maxdepth: 1
713
:caption: Contents
814

915
charter
16+
membership
1017
meeting_notes/index
1118
review_process
1219
ci_cd_guide/index

‎docs/meeting_notes/2024-08-21.rst‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
************
2+
Aug 21, 2024
3+
************
4+
5+
* Attendees:
6+
7+
- Andy Terrel, Seth Mridul, Nabil Freij
8+
9+
* Observers:
10+
11+
- Nicole Foster, Arliss Collins, Claudia Alvarado
12+
13+
* Apologies:
14+
15+
- Katrina Riehl, Irfan Alibay, Matt Moore
16+
17+
Notes
18+
=====
19+
20+
Pretalx Proposal Decision
21+
-------------------------
22+
23+
- It seems to be a cheaper option than currently
24+
- Nicole and Jim need to get proper quote and moving forward
25+
26+
- Jim is concerned about getting quick support
27+
28+
* Can this be part of the contract?
29+
30+
- Need to decide if Marty's work on Pretalx would fall under the DevOp role
31+
- Decision: wait to pursue after we hire devop role
32+
33+
DevOps Role
34+
------------
35+
36+
- Currently 2k+ applications have around ~13 in a shortlist
37+
- Infrastructure committee wants to be involved in the technical interview
38+
39+
- Need to come up with some fixed questions to ask them
40+
- Want to ensure that the interview is the same across all candidates
41+
42+
NF Summit
43+
----------
44+
45+
- There will be one unconference session on the infrastructure committee
46+
47+
- Want to bring up CI/CD guide
48+
- See if people know about the new process for requests from the committee
49+
- Do committees need common infrastructure that we can set up?
50+
51+
* Possible to unify how we do voting, notes and requests?
52+
* Want to improve transparency?
53+
54+
CI/CD Guide
55+
------------
56+
57+
- Skeleton setup on the repo. Now we can add the information needed
58+
59+
Action Items
60+
============
61+
62+
- Create a Google Forms survey which details: Nabil Freij
63+
64+
- What CI services are using currently and what architectures do you use on them?
65+
- Do they need paid services? If so, what ones and how much (rough estimate)?
66+
- What architectures do you want to run on?
67+
68+
- ~~Claudia - Create Calendly for Nabil, Andy, and Mridul for interviews (I'll create a group chat amongst us all to coordinate)~~
69+
70+
- ~~First interview- technical interview, add in fixed 85k rate in email send to Andy nvidia's email for faster response~~
71+
- ~~Create spreadsheet tracking candidates stages (contacted, interested, etc)~~
72+
73+
- ~~Andy, Mridul and Nabil: Create a checklist of questions to ensure a fair interview process via a shared Google Doc~~
74+
75+
- Nabil Freij: Upload these notes to the website

‎docs/meeting_notes/2024-09-18.rst‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
************
2+
Sep 18, 2024
3+
************
4+
5+
* Attendees:
6+
7+
- Andy Terrel, Nabil Freij
8+
9+
* Observers:
10+
11+
- Nicole Foster, Claudia Alvarado
12+
13+
* Apologies:
14+
15+
- Katrina Riehl, Irfan Alibay, Matt Moore, Arliss Collins, Seth Mridul
16+
17+
18+
Notes
19+
=====
20+
21+
IT DevOps Candidates
22+
--------------------
23+
24+
- DevOps Candidates Tracker
25+
- Go forward with one candidate for one final interview
26+
27+
* Andy will do the interview
28+
29+
Rackspace Billing
30+
-----------------
31+
32+
- 3 machines for conferences had networking turned off and no one said anything
33+
34+
* Machines will hopefully be deleted
35+
36+
- Need to check with Marty about if the machines have been backed up
37+
- Several projects or conferences have machines in Rackspace
38+
39+
* Need to contact the relevant parties to check if they are still being used
40+
41+
- New NumFOCUS account added
42+
- Bill is around $600 a month
43+
44+
Action Items
45+
------------
46+
47+
- Claudia: Contact Addo about final interview with Andy
48+
- Andy:
49+
50+
* Call Marty to check which Rackspace servers he needs before deleting anything
51+
* Claudia will ask Jim if Andy can join Marty's weekly check-in
52+
* Call Tom about pandas
53+
54+
- Claudia: Ask Jim about PyData Berlin and let Andy know
55+
- Nabil:
56+
57+
* Upload notes to repo
58+
* Create a list of items to discuss at the next meeting based on the summit BOF

0 commit comments

Comments
 (0)