-
Notifications
You must be signed in to change notification settings - Fork 69
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs-reorg: introduce "Join the community" section #746
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -103,12 +103,11 @@ When making your pull request, please keep the following in mind: | |
- Add tests and don't decrease test coverage. | ||
- Add documentation. | ||
- Follow our best practices: | ||
- [Data migrations](../howtos/alembic.md) | ||
- [Translation strings](../howtos/i18n.md) | ||
- [Translation strings](../../translations/i18n.md) | ||
- [CSS/JS](css-js.md) and [React](react.md) | ||
- [Web accessibility](accessibility.md) | ||
- [User interface](ui.md) | ||
- Identify the [copyright holder(s)](../../contribute/copyright-policy.md) and update copyright headers for touched files (>15 lines contributions). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Most changes are like this one: just involving path updates due to moving content around. |
||
- Identify the [copyright holder(s)](../../copyright-policy.md) and update copyright headers for touched files (>15 lines contributions). | ||
- New third-party code (copy/pasted source code or new dependencies) requires approval from architect or maintainer. | ||
- 🟢 Green light on all GitHub status checks is required in order to merge your | ||
PR. | ||
|
@@ -135,7 +134,7 @@ Follow these guidelines to minimize the risk of conflicts: | |
|
||
#### Code of conduct | ||
|
||
We expect everyone to comply with our [code of conduct](../../contribute/code-of-conduct.md) - be open, inclusive, considerate and respectful. | ||
We expect everyone to comply with our [code of conduct](../../code-of-conduct.md) - be open, inclusive, considerate and respectful. | ||
|
||
- *Reviewer*: Be respectful of the effort (often the labour was completed simply for the good of the community). | ||
- *Creator*: Be receptive to constructive comments and criticism (the reviews are labour intensive and serves to produce a better product and development for the community). | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,9 +16,9 @@ editable install of the Python package: | |
!!! note | ||
|
||
``mkvirtualenv`` is a tool provided by virtualenv-wrapper to manage Python | ||
virtualenvs. See [Python virtual environments](virtualenvs.md) | ||
virtualenvs. See [Python virtual environments](../../develop/getting-started/virtualenvs.md) | ||
|
||
``` | ||
```bash | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. occasional slight improvement |
||
cd ~/src/invenio-app-rdm | ||
mkvirtualenv app-rdm | ||
# opensearch2 only needed for certain modules | ||
|
@@ -33,7 +33,7 @@ you won't have all the tools needed for testing. | |
|
||
Running the test is normally as simple as: | ||
|
||
``` | ||
```bash | ||
./run-tests.sh | ||
``` | ||
|
||
|
@@ -59,14 +59,13 @@ to a single module: | |
First make sure you have the source code of both modules. Next, simply do | ||
editable installs of both: | ||
|
||
``` | ||
```bash | ||
mkvirtualenv communities | ||
pip install -e "~/src/invenio-communities[tests,opensearch2]" \ | ||
-e "~/src/invenio-requests[tests,elasticsearch7]" | ||
``` | ||
|
||
### Application integration | ||
|
||
See the section [instance development](instance-development.md) for how to | ||
integrate your development versions in the InvenioRDM application. | ||
|
||
See the section on [pre-release instance development](prerelease-instance-development.md) for how to | ||
integrate your development version(s) in a development InvenioRDM application for integration testing. |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,47 +3,48 @@ | |
For development you need the latest ``master`` or ``main`` branch of the source | ||
code (name depends on the repository). | ||
|
||
Following show you to fork the repository and checkout the source code. | ||
### How to fork a repository and checkout the source code | ||
|
||
### With GitHub CLI | ||
=== "With GitHub CLI" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Kind of experimentally snuck this one in. It tabs the content and makes the documentation much more compact / less daunting. It's only used here, but could be adopted for other sections. |
||
|
||
First checkout the source code from GitHub and get the latest ``master`` or | ||
``main`` branch (depends on the repository which name is used). | ||
First checkout the source code from GitHub and get the latest ``master`` or | ||
``main`` branch (depends on the repository which name is used). | ||
|
||
This is most easily done using the [GitHub CLI tool](https://cli.github.com): | ||
This is most easily done using the [GitHub CLI tool](https://cli.github.com): | ||
|
||
``` | ||
# with GitHub CLI tool: | ||
gh repo fork inveniosoftware/invenio-app-rdm | ||
cd invenio-app-rdm | ||
``` | ||
```bash | ||
# with GitHub CLI tool: | ||
gh repo fork inveniosoftware/invenio-app-rdm | ||
cd invenio-app-rdm | ||
``` | ||
|
||
With the previous command, we made a checkout of [Invenio-App-RDM](https://github.com/inveniosoftware/invenio-app-rdm) module. You'll have to adapt the command to checkout the module you want to work on. | ||
With the previous command, we made a checkout of [Invenio-App-RDM](https://github.com/inveniosoftware/invenio-app-rdm) module. You'll have to adapt the command to checkout the module you want to work on. | ||
|
||
### Without GitHub CLI | ||
=== "Without GitHub CLI" | ||
|
||
Without the GitHub CLI tool, you'll first have to [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) | ||
on GitHub. Then, once you have a fork you can clone the repository and add the | ||
upstream repository remote: | ||
Without the GitHub CLI tool, you'll first have to [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) | ||
on GitHub. Then, once you have a fork you can clone the repository and add the | ||
upstream repository remote: | ||
|
||
```bash | ||
# without GitHub CLI: | ||
git clone https://github.com/<your username>/invenio-app-rdm | ||
cd invenio-app-rdm | ||
git remote add upstream [email protected]:inveniosoftware/invenio-app-rdm.git | ||
``` | ||
|
||
``` | ||
# without GitHub CLI: | ||
git clone https://github.com/<your username>/invenio-app-rdm | ||
cd invenio-app-rdm | ||
git remote add upstream [email protected]:inveniosoftware/invenio-app-rdm.git | ||
``` | ||
|
||
### Repositories survival guide | ||
|
||
The InvenioRDM codebase is split over a number of different repositories. Below you'll find a short overview over the most | ||
|
||
 | ||
 | ||
|
||
- CLI tool | ||
- [invenio-cli](https://github.com/inveniosoftware/) | ||
- [invenio-cli](https://github.com/inveniosoftware/invenio-cli) | ||
- Standalone CLI tool used to install and manage InvenioRDM. | ||
- Instance template | ||
- [cookiecutter-invenio-instance](https://github.com/inveniosoftware/) | ||
- [cookiecutter-invenio-instance](https://github.com/inveniosoftware/cookiecutter-invenio-rdm) | ||
- Template for the project folder created by ``invenio-cli``. | ||
- Application repositories | ||
- [invenio-app-rdm](https://github.com/inveniosoftware/invenio-app-rdm) | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Onboarding | ||
# Onboard | ||
|
||
Welcome to the InvenioRDM and to our collaborative, open source community! | ||
|
||
|
@@ -7,8 +7,7 @@ Find here important resources for onboarding. | |
## For everyone | ||
<!---* Mailing list (self-subscribe): https://lists.e-infra.cz/wws/info/project-inveniordm | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can the self-subscribe to the Mailing List be added back? |
||
* Telecon invite (2x per month all-partner meeting, alternate Tuesdays): [Calendar invitation](https://calendar.google.com/calendar/ical/4et3h2ucvb24u1dsn8elif9h14%40group.calendar.google.com/private-2553e786a8db386368e6697f569a3b8d/basic.ics)--> | ||
* Telecon schedule 2024: [Google Calendar](https://docs.google.com/document/d/1vSClxJbQv296Zk9DIX8aWa6kEbzcnXSFExHuWvTYV7E) | ||
* Telecon agenda: [Google Docs](https://docs.google.com/document/d/166v5oqVxzQQ8U4-eo2EraCpohnnAjeANdLJ6nnCy1uA) | ||
* Telecon schedule 2025: [Google Docs](https://docs.google.com/document/d/1KWvDoVN0hx4jG5wfm4BF322Gyf06dLNuvrAvrbXL9Mc) | ||
* Chat on Discord: <https://discord.com/invite/8qatqBC> | ||
* Discussion forum on Discourse: <https://invenio-talk.web.cern.ch> | ||
* Blog: <https://inveniosoftware.org/blog/> | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My sense is that it's a maintainer that is more likely to deal with migrations, so it's not included in this section. It's more involved too, so it can be pushed deeper in the documentation.