diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6ae25cf8d..0974a0df4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. @@ -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: @@ -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: @@ -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. diff --git a/CREDITS b/CREDITS index 700c97f1a..96872553e 100644 --- a/CREDITS +++ b/CREDITS @@ -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 diff --git a/Dockerfile b/Dockerfile index c8a23a3e6..28018a17f 100644 --- a/Dockerfile +++ b/Dockerfile @@ -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 . diff --git a/META6.json b/META6.json index 9d01c0fa0..387addca6 100644 --- a/META6.json +++ b/META6.json @@ -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": [ @@ -37,6 +37,6 @@ "documentation", "reference" ], - "source-url": "git://github.com/perl6/doc.git", + "source-url": "git://github.com/Raku/doc.git", "meta6": "0" -} \ No newline at end of file +} diff --git a/Makefile b/Makefile index 56847f9c6..69b02311e 100644 --- a/Makefile +++ b/Makefile @@ -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: diff --git a/README.md b/README.md index 3c48622e6..d7b7369b1 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. @@ -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. @@ -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. @@ -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) diff --git a/assets/doc-generation.json b/assets/doc-generation.json index 6ef8e223f..b3b8d9920 100644 --- a/assets/doc-generation.json +++ b/assets/doc-generation.json @@ -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", diff --git a/doc/404.pod6 b/doc/404.pod6 index ace7462da..347e28ce5 100644 --- a/doc/404.pod6 +++ b/doc/404.pod6 @@ -9,7 +9,7 @@
  • If you got here by following a link on this site or as a result of searching on it, please report it - on our GitHub repository + on our GitHub repository so we can fix it!
  • 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.
  • 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.
  • diff --git a/doc/HomePage.pod6 b/doc/HomePage.pod6 index e11452dc1..2f954121e 100644 --- a/doc/HomePage.pod6 +++ b/doc/HomePage.pod6 @@ -4,7 +4,7 @@ Welcome to the official documentation of the Raku programming language! Besides online browsing and searching, you can also view everything in one file or -contribute +contribute by reporting issues or sending patches.
    diff --git a/template/footer.html b/template/footer.html index a5b2521d5..ac74bded9 100644 --- a/template/footer.html +++ b/template/footer.html @@ -5,10 +5,10 @@ known to be incomplete.

    Please report any issues.Your contribution is appreciated.

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

    This documentation is provided under the terms of the - Artistic License 2.0. + Artistic License 2.0. The Camelia image is copyright © 2009 by Larry Wall.