Skip to content

Commit

Permalink
Ref #96. Includes section for publish_wiki() in vignettes
Browse files Browse the repository at this point in the history
  • Loading branch information
danielgranadoscampos committed Mar 4, 2022
1 parent 7cb4ed6 commit cfeed91
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 3 deletions.
Binary file added vignettes/img/clone_wiki.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 12 additions & 3 deletions vignettes/ixplorer.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,16 @@ instancia guardada en
credenciales de git en su servior remoto. El default es de 4 horas. La
función toma su tiempo en segundos.




#### Publicar un wiki

* **publica_wiki()**. Los wikis son de especial importancia cuando se quiere
documentar de manera sencilla lo que sucede en el repositorio. Para publicar un
wiki con publica_wiki(), el primer paso es crear la primera página manualmente.
Esto se logra en la pestaña de "wiki" en el repositorio.
El siguiente paso es clonar el repositorio del wiki.
Este url para clonar el wiki es diferente al que usamos para clonar el repositorio
donde encontramos nuestro código. Una vez que clonamos este repositorio podemos
usar publica_wiki().

![](img/clone_wiki.png)

10 changes: 10 additions & 0 deletions vignettes/ixplorer_en.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,17 @@ instance saved.
git credentials on your remote server. The default is 4 hours. The
function takes its time in seconds.

#### Publishing on wiki
* **publish_wiki()**: Allows you to publish a wiki in your repo from an Rmarkdown.
Wikis are especially important when you want to easily document what happens in
the repository. To publish a wiki with publish_wiki(), the first step is to create
the first page manually. This is accomplished in the "wiki" tab in the repository.
The next step is to clone the wiki repository.
This url to clone the wiki is different from the one we use to clone the
repository where we find our code. Once we clone this repository we can use
publish_wiki().

![](img/clone_wiki.png)



0 comments on commit cfeed91

Please sign in to comment.