Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@JFormoso
JFormoso authored Sep 20, 2024
1 parent bbe8bbe commit 605d56d
Showing 1 changed file with 9 additions and 241 deletions.
250 changes: 9 additions & 241 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,249 +1,17 @@
# training-template
# Entrenamiento Docente

This repository is [The Carpentries'][carpentry-site]
template for creating websites for Instructor Training workshops.
Este repositorio corresponde al Entrenamiento Docente (Instructor Training) dictado por [MetaDocencia](https://www.metadocencia.org/) con [The Carpentries][carpentry-site] en el marco del proyecto [Catalyst](https://catalystproject.cloud/).

1. Please *do not fork this repository directly on GitHub.*
Instead, please use [the instructions below](#creating-a-repository)
to copy this `training-template` repository and customize it for your workshop.
# ---------------

2. Customise the values in `_config.yml` and the header of `index.md`
(or `index.md.cldt` for Collaborative Lesson Development Training)
to configure the website for your training event.
Please *do your work in your repository's `gh-pages` branch*,
since that is what is
[automatically published as a website by GitHub][github-project-pages].
Como parte de la etapa de entrenamiento ofrecida a las comunidades participantes del proyecto Catalyst, invitamos a los Campeones y Campeonas de Hub a sumarse a la Formación de Instructores de T[The Carpentries][carpentry-site]. Para las comunidades de habla hispana [MetaDocencia](https://www.metadocencia.org/) estará llevando adelante una versión completamente en español.

3. (Collaborative Lesson Development Training events only)
Rename `index.md.cldt` to `index.md` (replacing the original `index.md`)
to use this file as the source of the training event page.
Esta formación introduce a quienes asisten a prácticas de enseñanzas basadas en evidencia, les enseña cómo crear ambientes positivos para quienes participan de sus talleres y les provee con oportunidades de practicar y desarrollar habilidades de enseñanza.

4. Once you are done,
please **send your repository's URL to The Carpentries contact]**.
For an Instructor Training event send the URL to <[email protected]>.
For Collaborative Lesson Development Training, send to <[email protected]>.
Para obtener la certificación de The Carpentries es necesario participar de los cuatros días de formación y seguir una serie de pasos (“checkout”).

If you run into problems,
or have ideas about how to make this process simpler,
please [get in touch](#getting-and-giving-help).
The section on [customizing your website][customization],
and the [FAQ][faq] and [design notes][design] from the related template for workshop websites
have more detail on what we do and why.
Además de mejorar sus habilidades de enseñanza durante el entrenamiento, quienes participen tendrán ocasión de sumarse a la comunidad de MetaDocencia y quienes se certifiquen se sumarán a una comunidad global y establecida de [instructores e instructoras](https://carpentries.org/instructors/).

## Creating a Repository
Sitio web del taller: https://metadocencia.github.io/2024-09-24-ttt-online/

1. Log in to GitHub.
(If you do not have an account, you can quickly create one for free.)
You must be logged in for the remaining steps to work.

2. On this page (<https://github.com/carpentries/training-template>),
click on the green "Use this template" button (top right)

![screenshot of this repository's GitHub page with an arrow pointing to the the 'use this template' button on the top left](fig/select-github-use-template.png?raw=true)

3. Select the owner for your new repository.
(This will probably be you, but may instead be an organization you belong to.)

4. Choose a name for your workshop website repository.
For **Instructor Training**, this name should have the form `YYYY-MM-DD-ttt-site`,
e.g., `2016-12-01-ttt-oomza`,
where `YYYY-MM-DD` is the start date of the training.
For **Collaborative Lesson Development Training**,
the name should have the form `YYYY-MM-DD-cldt-partN-site`,
where `YYYY-MM-DD` is the start date of the training
and `N` is a number indicating the part of the training (1 or 2)
that will be taught at this event.
  For online workshops, choose `online` as `site`.
In most cases, the Instructor Training Team will tell you
the name of the repository you should use.

5. Make sure the repository is public, leave "Include all branches" unchecked, and click on "Create
repository from template". You will be redirected to your new copy of the workshop template
respository.

6. With a repository called `YYYY-MM-DD-ttt-site`,
your new website will be rendered at `https://your_username.github.io/YYYY-MM-DD-ttt-site`.


## Customizing Your Website

(For Collaborative Lesson Development Training, follow the steps described here
but modify the `index.md.cldt` file instead.)

1. Go into your newly-created repository,
which will be at `https://github.com/your_username/YYYY-MM-DD-ttt-site`.
For example,
if your username is `gvwilson`,
the repository's URL will be `https://github.com/gvwilson/2016-12-01-ttt-oomza`.

3. Ensure you are on the gh-pages branch by clicking on the branch under the drop
down in the menu bar (see the note below):

![](fig/select-gh-pages-branch.png?raw=true)

3. Edit the header of `index.md` to customize the list of instructors,
workshop venue, etc.
You can do this in the browser by clicking on it in the file view on GitHub
and then selecting the pencil icon in the menu bar:

![](fig/edit-index-file-menu-bar.png?raw=true)

Editing hints are embedded in `index.md`,
and full instructions are in [the customization instructions][customization].

6. Alternatively,
if you are already familiar with Git,
you can clone the repository to your desktop,
and edit `index.md` there,
and push your changes back to the repository.

~~~
git clone https://github.com/your_username/YYYY-MM-DD-ttt-site
~~~
You should specify `-b gh-pages` to checkout the gh-pages branch because the imported
repository doesn't have a `master` branch.
In order to view your changes once you are done editing,
you must push to your GitHub repository:
~~~
git push origin gh-pages
~~~
7. (Collaborative Lesson Development Training events only)
Rename `index.md.cldt` to `index.md` (replacing the original `index.md`)
to use this file as the source of the training event page.
If you are working locally, this can be achieved with the command
`git mv index.md.cldt index.md`.
8. When you are done editing,
go to the GitHub Pages URL for your workshop and preview your changes.
In the example above, this is `https://gvwilson.github.io/2016-12-01-ttt-oomza`.
The finished page should look [something like this](fig/completed-page.png?raw=true).
9. Optional: you can now change the `README.md` file in your website's repository, which contains these instructions, so that it contains a short description of your workshop and a link to the training website.
10. Optional: Add a link to your workshop website on the repository main page in the description/website section (look for the `Edit` button on the right to add).
**Note:**
please do all of your work in your repository's `gh-pages` branch,
since [GitHub automatically publishes that as a website][github-project-pages].
## (Optional) Checking Your Changes Locally
If you want to preview your changes on your own machine before publishing them on GitHub,
you can do so as described below.
1. Install the software [described below](#installing-software).
This may require some work,
so feel free to preview by pushing to the website.
2. Run the command
~~~
make serve
~~~
and go to <http://0.0.0.0:4000> to preview your site.
You can also run this command by typing `make serve`
(if you have Make installed).
3. Run the command
~~~
make workshop-check
~~~
to check for a few common errors in your workshop's home page.
(You must have Python 3 installed to do this.)
## (Optional) Linking to Your Page
At the top of your repository on GitHub you'll see
~~~
No description, website, or topics provided. — Edit
~~~
Click 'Edit' and add:
1. A very brief description of your workshop in the "Description" box (e.g., "Oomza University workshop, Dec. 2016")
2. The URL for your workshop in the "Website" box (e.g., `https://gvwilson.github.io/2016-12-01-ttt-oomza`)
This will help people find your website if they come to your repository's home page.
## Creating Extra Pages
In rare cases,
you may want to add extra pages to your workshop website.
You can do this by putting either Markdown or HTML pages in the website's root directory
and styling them according to the instructions give in
[the lesson template][lesson-example].
If you do this,
you *must* also edit `_config.yml` to set these three values:
1. `carpentry` is "cp" (for The Carpentries).
This determines which logo is loaded.
2. `title` is the title of your workshop (typically the venue and date).
Note: `carpentry` and `email` duplicate information that's in `index.md`,
but there is no way to avoid this
without requiring people to edit both files in the usual case
where no extra pages are created.
## Installing Software
If you want to set up Jekyll
so that you can preview changes on your own machine before pushing them to GitHub,
you must install the software described below.
(Note: Julian Thilo has written instructions for
[installing Jekyll on Windows][jekyll-windows].)
1. **Ruby**.
This is included with Linux and macOS;
the simplest option on Windows is to use [RubyInstaller][ruby-installer].
You can test your installation by running `ruby --version`.
For more information,
see [the Ruby installation guidelines][ruby-install-guide].
2. **[RubyGems][rubygems]**
(the package manager for Ruby).
You can test your installation by running `gem --version`.
3. **[Jekyll][jekyll]**.
You can install this by running `gem install jekyll`.
You can check the formatting of your header by running `bin/workshop_check.py`
(which is invoked by `make workshop-check`).
You must have Python 3 installed in order to do this,
and you will also need the [PyYAML][pyyaml] module.
## Getting and Giving Help
We are committed to offering a pleasant setup experience for our learners, Trainers, Instructors and workshop hosts.
If you find bugs in our instructions,
or would like to suggest improvements,
please [file an issue][issues]
or [mail us][contact].
[carpentry-site]: https://carpentries.org/
[contact]: mailto:[email protected]
[customization]: https://github.com/carpentries/training-template#customizing-your-website
[design]: https://carpentries.github.io/workshop-template/design/
[faq]: https://carpentries.github.io/workshop-template/faq/
[github-project-pages]: https://help.github.com/articles/creating-project-pages-manually/
[importer]: http://import.github.com/new
[issues]: https://github.com/carpentries/training-template/issues
[jekyll]: https://jekyllrb.com/
[jekyll-windows]: http://jekyll-windows.juthilo.com/
[lesson-example]: https://carpentries.github.io/lesson-example/
[pyyaml]: https://pypi.python.org/pypi/PyYAML
[ruby-install-guide]: https://www.ruby-lang.org/en/downloads/
[ruby-installer]: http://rubyinstaller.org/
[rubygems]: https://rubygems.org/pages/download/
[self-organized-workshop-form]: https://amy.carpentries.org/forms/self-organised/
[swc-site]: http://software-carpentry.org
[lc-site]: https://librarycarpentry.org
Todos los materiales se encuentran disponibles bajo la licencia [Creative Commons Attribution](https://creativecommons.org/licenses/by/4.0/).

0 comments on commit 605d56d

Please sign in to comment.