Skip to content

Commit

Permalink
Replaces repo name Raku#3101
Browse files Browse the repository at this point in the history
  • Loading branch information
JJ committed Nov 29, 2019
1 parent e25bfef commit 0b35dda
Show file tree
Hide file tree
Showing 10 changed files with 30 additions and 30 deletions.
22 changes: 11 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing

Your patches to `perl6/doc` are very welcome, and if you want to
Your patches to `Raku/doc` are very welcome, and if you want to
help,
[please read this guide](https://dev.to/jj/squashing-perl-6-documentation-bugs-one-at-a-time-4ojn) as
well as the detailed instructions below.
Expand Down Expand Up @@ -68,7 +68,7 @@ available when writing code examples in the documentation.
## Adding a new Language document

We suggest you discuss proposing a new Language document on the #raku
channel and/or the [issues for this repository](https://github.com/perl6/doc/issues)
channel and/or the [issues for this repository](https://github.com/Raku/doc/issues)
before you proceed further. After you get consensus on a title, subtitle,
section, and filename, you can add the document by following these steps:

Expand Down Expand Up @@ -192,27 +192,27 @@ to display heading numbers.

## Reporting bugs

Report issues at https://github.com/perl6/doc/issues. You can
Report issues at https://github.com/Raku/doc/issues. You can
use
[labels when tagging tickets](https://github.com/perl6/doc/labels),
[labels when tagging tickets](https://github.com/Raku/doc/labels),
among which these are probably the most common:

* [`docs`](https://github.com/perl6/doc/labels/docs) - missing or
* [`docs`](https://github.com/Raku/doc/labels/docs) - missing or
incorrect documentation;
use [`NOTSPECCED`](https://github.com/perl6/doc/labels/NOTSPECCED)
use [`NOTSPECCED`](https://github.com/Raku/doc/labels/NOTSPECCED)
instead, if this is for a feature present in a compiler, but not in
the Raku test suite.
* [`search`](https://github.com/perl6/doc/labels/search) - the search
* [`search`](https://github.com/Raku/doc/labels/search) - the search
component, either for items that are on the site but not searchable,
or for the search functionality itself.

If you would like to contribute documentation or other bug fixes, please use
[GitHub's pull requests](https://github.com/perl6/doc/pulls).
[GitHub's pull requests](https://github.com/Raku/doc/pulls).

## Building the documentation

Assuming that you have already forked and cloned the
[perl6/doc](https://github.com/perl6/doc) repository, one of the first things
[Raku/doc](https://github.com/Raku/doc) repository, one of the first things
you probably want to do is to build the documentation on your local
computer. To do this you will need:

Expand Down Expand Up @@ -318,12 +318,12 @@ You can skip all the above and just build and view documentation with these
simple commands (if you have docker already installed):

$ docker build -t perl6-doc .
$ docker run -p 3000:3000 -it -v `pwd`:/perl6/doc perl6-doc
$ docker run -p 3000:3000 -it -v `pwd`:/Raku/doc perl6-doc

This will build the documentation for you by default and it will take some time,
but for subsequent use you may want to skip build part if nothing has been changed:

$ docker run -p 3000:3000 -it -v `pwd`:/perl6/doc perl6-doc ./app-start
$ docker run -p 3000:3000 -it -v `pwd`:/Raku/doc perl6-doc ./app-start

Now point your web browser to http://localhost:3000 to view the documentation.

Expand Down
2 changes: 1 addition & 1 deletion CREDITS
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

Thanks,

The perl6/doc Team
The Raku/doc Team
PS: Yes, this looks remarkably like the Linux CREDITS format
PPS: This file is encoded in UTF-8

Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ RUN buildDeps=' \
&& chmod +x "$n" \
&& n stable

WORKDIR /perl6/doc
WORKDIR /Raku/doc
COPY . .
RUN zef install zef && zef update && zef install --deps-only .

Expand Down
6 changes: 3 additions & 3 deletions META6.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"Test-Files": "lib/Test-Files.pm6"
},
"support": {
"source": "git://github.com/perl6/doc.git"
"source": "git://github.com/Raku/doc.git"
},
"license": "Artistic-2.0",
"tags": [
Expand All @@ -37,6 +37,6 @@
"documentation",
"reference"
],
"source-url": "git://github.com/perl6/doc.git",
"source-url": "git://github.com/Raku/doc.git",
"meta6": "0"
}
}
8 changes: 4 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -80,21 +80,21 @@ docker-image:
docker build -t $(DOCKER_IMAGE_NAME) .

docker-test: docker-image
docker run --rm -it -v $(REPO_PATH):/perl6/doc/$(SELINUX_OPT) $(DOCKER_IMAGE_NAME) \
docker run --rm -it -v $(REPO_PATH):/Raku/doc/$(SELINUX_OPT) $(DOCKER_IMAGE_NAME) \
/bin/bash -c 'make test'

docker-xtest: docker-image
docker run --rm -it -v $(REPO_PATH):/perl6/doc/$(SELINUX_OPT) $(DOCKER_IMAGE_NAME) \
docker run --rm -it -v $(REPO_PATH):/Raku/doc/$(SELINUX_OPT) $(DOCKER_IMAGE_NAME) \
/bin/bash -c 'make xtest'

docker-ctest: docker-image
docker run --rm -it -v $(REPO_PATH):/perl6/doc/$(SELINUX_OPT) $(DOCKER_IMAGE_NAME) \
docker run --rm -it -v $(REPO_PATH):/Raku/doc/$(SELINUX_OPT) $(DOCKER_IMAGE_NAME) \
/bin/bash -c 'make ctest'

docker-testall: docker-test docker-xtest docker-ctest

docker-run: docker-image
docker run --rm -it -p $(DOCKER_HOST_PORT):3000 -v $(REPO_PATH):/perl6/doc/$(SELINUX_OPT) \
docker run --rm -it -p $(DOCKER_HOST_PORT):3000 -v $(REPO_PATH):/Raku/doc/$(SELINUX_OPT) \
$(DOCKER_IMAGE_NAME) /bin/bash -c './app-start' &

clean-html:
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Official Documentation of Raku

[![Build Status](https://travis-ci.org/perl6/doc.svg?branch=master)](https://travis-ci.org/perl6/doc) [![artistic](https://img.shields.io/badge/license-Artistic%202.0-blue.svg?style=flat)](https://opensource.org/licenses/Artistic-2.0) [![Run Status](https://api.shippable.com/projects/591e99923f2f790700098a30/badge?branch=master)](https://app.shippable.com/github/perl6/doc) [![CircleCI](https://circleci.com/gh/perl6/doc.svg?style=shield)](https://circleci.com/gh/perl6/doc/tree/master)
[![Build Status](https://travis-ci.org/Raku/doc.svg?branch=master)](https://travis-ci.org/Raku/doc) [![artistic](https://img.shields.io/badge/license-Artistic%202.0-blue.svg?style=flat)](https://opensource.org/licenses/Artistic-2.0) [![Run Status](https://api.shippable.com/projects/591e99923f2f790700098a30/badge?branch=master)](https://app.shippable.com/github/Raku/doc) [![CircleCI](https://circleci.com/gh/Raku/doc.svg?style=shield)](https://circleci.com/gh/Raku/doc/tree/master)

An HTML version of this documentation can be found
at [https://docs.perl6.org/](https://docs.perl6.org/) and also
Expand Down Expand Up @@ -111,7 +111,7 @@ Please follow these instructions (in Ubuntu) to install them
This should install all needed requisites, now you can clone this repository
and start building process:

git clone https://github.com/perl6/doc.git # clone the repo
git clone https://github.com/Raku/doc.git # clone the repo
cd doc # move to the clone of the repo
make for-documentable # Generates CSS and JS, installs highlighting modules
documentable start -a -v --highlight # Builds cache and generates pages.
Expand Down Expand Up @@ -168,7 +168,7 @@ Here are some ways to help us:
* Do a `git grep TODO` in this repository, and replace the TODO items by
actual documentation.

[Issues page](https://github.com/perl6/doc/issues) has a list of current issues and
[Issues page](https://github.com/Raku/doc/issues) has a list of current issues and
documentation parts that are known to be missing
and [the CONTRIBUTING document](CONTRIBUTING.md)
explains briefly how to get started contributing documentation.
Expand Down Expand Up @@ -197,7 +197,7 @@ explains briefly how to get started contributing documentation.

## Vision

> I want p6doc and docs.perl6.org to become the No. 1 resource to consult
> I want p6doc and docs.raku.org to become the No. 1 resource to consult
> when you want to know something about a Raku feature, be it from the
> language, or built-in types and routines. I want it to be useful to every
> Raku programmer.
Expand Down Expand Up @@ -225,6 +225,6 @@ files indicate the copyright and license terms at the top of the file. Currently
* [jQuery Cookie plugin](https://github.com/js-cookie/js-cookie):
Copyright 2006, 2015 Klaus Hartl & Fagner Brack;
[MIT License](http://creativecommons.org/licenses/MIT)
* Examples from Stack Overflow [MIT License](http://creativecommons.org/licenses/MIT); ([ref #1](http://stackoverflow.com/a/43669837/215487) for [1f7cc4e](https://github.com/perl6/doc/commit/1f7cc4efa0da38b5a9bf544c9b13cc335f87f7f6))
* Examples from Stack Overflow [MIT License](http://creativecommons.org/licenses/MIT); ([ref #1](http://stackoverflow.com/a/43669837/215487) for [1f7cc4e](https://github.com/Raku/doc/commit/1f7cc4efa0da38b5a9bf544c9b13cc335f87f7f6))
* Table sorter plugin from https://github.com/christianbach/tablesorter ;
[MIT License](http://creativecommons.org/licenses/MIT)
2 changes: 1 addition & 1 deletion assets/doc-generation.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"title-page": "Raku Documentation",
"pod-root-path": "https://github.com/perl6/doc/blob/master/doc",
"pod-root-path": "https://github.com/Raku/doc/blob/master/doc",
"kinds": [
{
"kind": "language",
Expand Down
2 changes: 1 addition & 1 deletion doc/404.pod6
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<li> If you got here by following
a link on this site or as a result of searching on it, please report it
<a href="https://github.com/perl6/doc/issues/">on our GitHub repository</a>
<a href="https://github.com/Raku/doc/issues/">on our GitHub repository</a>
so we can fix it!</li>
<li>If a search engine sent you here, the link might have disappeared due to site reorganization. We still encourage you to report it as above, but it will eventually disappear from search engines too.</li>
<li>If you came following a link from some site or blog, we would still want to know about that; you might want to report the blog or website author too.</li>
Expand Down
2 changes: 1 addition & 1 deletion doc/HomePage.pod6
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Welcome to the official documentation of the <a href="https://raku.org">Raku</a>
programming language!
Besides online browsing and searching, you can also
<a href="/perl6.html">view everything in one file</a> or
<a href="https://github.com/perl6/doc">contribute</a>
<a href="https://github.com/Raku/doc">contribute</a>
by reporting issues or sending patches.
<hr/>
Expand Down
4 changes: 2 additions & 2 deletions template/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
known to be incomplete.</p>

<p><a
href="https://github.com/perl6/doc/blob/master/CONTRIBUTING.md#reporting-bugs">Please report any issues</a>.Your contribution is appreciated.</p>
href="https://github.com/Raku/doc/blob/master/CONTRIBUTING.md#reporting-bugs">Please report any issues</a>.Your contribution is appreciated.</p>

<p> This documentation is provided under the terms of the
<a href="https://raw.githubusercontent.com/perl6/doc/master/LICENSE">Artistic License 2.0</a>.
<a href="https://raw.githubusercontent.com/Raku/doc/master/LICENSE">Artistic License 2.0</a>.
The Camelia image is <a href="https://raw.githubusercontent.com/perl6/mu/master/misc/camelia.txt"
>copyright © 2009 by Larry Wall.</a>
<!-- CREDITS -->
Expand Down

0 comments on commit 0b35dda

Please sign in to comment.