Skip to content

Commit

Permalink
Merge branch 'main' into documentation2712
Browse files Browse the repository at this point in the history
  • Loading branch information
YurelyCamacho authored Dec 27, 2024
2 parents fa5c943 + d1a12f6 commit defb4c7
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 8 deletions.
2 changes: 2 additions & 0 deletions docs/description.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ needs.
- **Automates workflows:** Streamlines processes like documentation generation,
version control, and continuous integration.


### Getting Started

**Prerequisites**
Expand Down Expand Up @@ -101,6 +102,7 @@ used.)_
- [Contribution Guide](https://github.com/osl-incubator/scicookie/blob/main/docs/contributing.md)
- [Tutorial](https://youtu.be/GozNb4i47Ds?si=MIqJC56Ernvxpj_i)


### Support

- Star us on [GitHub](https://github.com/osl-incubator/scicookie).
Expand Down
16 changes: 8 additions & 8 deletions docs/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -784,12 +784,12 @@ development process. In SciCookie you have the option of using _Docker_.
configurations. You can read more about this on the
[Docker website](https://www.docker.com/) and in the
[Docker documentation](https://docs.docker.com/).

SciCookie can work with [**Podman**](https://podman.io/), but is supported via
[`docker-compose`](https://docs.docker.com/compose/).

Overall, Docker is a powerful tools for managing and deploying containerized
applications, and can provide a streamlined and efficient platform for running
application, and can provide a streamlined and efficient platform for running
Python projects.

In case you do not want to include DevOps in your project, you can do so by
Expand All @@ -803,7 +803,7 @@ tools are used to streamline and optimize various operations, reduce human
intervention, increase efficiency, and minimize errors. Currently, SciCookie
allows you to use `Make` and/or `Makim`.

- [Makim](https://osl-incubator.github.io/makim): Makim is an innovative tool
- [**Makim**](https://osl-incubator.github.io/makim): Makim is an innovative tool
inspired by make, designed to simplify target and dependency definition
through YAML format. It introduces advanced features such as conditionals,
arguments, and dependencies with targeted parameters. It also facilitates
Expand All @@ -813,7 +813,7 @@ allows you to use `Make` and/or `Makim`.
improved target management while maintaining compatibility with familiar YAML
syntax.

- [Make](<https://en.wikipedia.org/wiki/Make_(software)>): Make is a versatile
- [**Make**](<https://en.wikipedia.org/wiki/Make_(software)>): Make is a versatile
build automation tool that uses Makefiles to define rules and dependencies for
compiling code and building projects. It automates the process, intelligently
rebuilding only changed components, streamlining software development
Expand Down Expand Up @@ -984,22 +984,22 @@ quickly identify and fix problems. By automating repetitive tasks, CI also saves
time and effort. With SciCookie you can integrate tools like GitHub and/or
CircleCI into your project.

- [GitHub Actions](https://github.com/features/actions) (**github_actions**):
- [**GitHub Actions**](https://github.com/features/actions) (**github_actions**):
This option allows you to incorporate GitHub Actions into your project. As a
native CI/CD platform integrated with GitHub, it offers flexible workflows and
an easy setup process.
- [CircleCI](https://circleci.com/) (**circleci**): This option enables you to
- [**CircleCI**](https://circleci.com/) (**circleci**): This option enables you to
integrate CircleCI into your project. Known for its speed and reliability,
CircleCI is a cloud-based CI/CD platform that streamlines the development
process.
- [Azure Pipelines](https://azure.microsoft.com/products/devops/pipelines/)
- [**Azure Pipelines**](https://azure.microsoft.com/products/devops/pipelines/)
(**azure_pipelines**): With this option, you can integrate Azure Pipelines
into your into your project. It is a robust CI/CD platform that enables
automation of testing and deployments across multiple environments and
supports multiple languages and platforms. It provides continuous integration
with GitHub, Azure Repos and other version control systems, facilitating an
agile and efficient workflow.
- [GitLab CI/CD](https://about.gitlab.com/topics/ci-cd/) (**gitlab_ci**): GitLab
- [**GitLab CI/CD**](https://about.gitlab.com/topics/ci-cd/) (**gitlab_ci**): GitLab
CI/CD helps you realize the vision of software development that is iterative,
tested, and always releasing. Measure developer productivity and watch it
improve with one unified tool that encourages collaboration, immediate
Expand Down
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,9 @@ Python package.

## Quickstart

Install the latest Cookiecutter if you haven't installed it yet (this requires
Cookiecutter 1.0.0):

```bash
pip install scicookie
```
Expand Down Expand Up @@ -117,6 +120,7 @@ You can also use it with `pipx`:
pipx run scicookie --profile osl
```


## Development

For testing your changes locally, you can run:
Expand Down
1 change: 1 addition & 0 deletions src/scicookie/{{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

- Software License: {{ cookiecutter.project_license }}
{%- endif %}

- Documentation: https://{{ cookiecutter.project_slug }}.github.io

## Features
Expand Down

0 comments on commit defb4c7

Please sign in to comment.