diff --git a/README.md b/README.md index b00e830..b504432 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# spotify/mkdocs-monorepo-plugin +# backstage/mkdocs-monorepo-plugin -[![](https://github.com/spotify/mkdocs-monorepo-plugin/workflows/Build%2C%20Test%20%26%20Deploy/badge.svg)](https://github.com/spotify/mkdocs-monorepo-plugin/actions) +[![](https://github.com/backstage/mkdocs-monorepo-plugin/workflows/Build%2C%20Test%20%26%20Deploy/badge.svg)](https://github.com/backstage/mkdocs-monorepo-plugin/actions) [![PyPI](https://img.shields.io/pypi/v/mkdocs-monorepo-plugin)](https://pypi.org/project/mkdocs-monorepo-plugin/) ![](https://img.shields.io/badge/lifecycle-beta-509bf5.svg) [![PyPI - License](https://img.shields.io/pypi/l/mkdocs-monorepo-plugin)](LICENSE) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 6507999..18b10fe 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## 0.4.11 + +- Moved repository to the Backstage organization + ## 0.4.10 - New fix for previous issue which doesn't break when site_name contains a slash @@ -14,7 +18,7 @@ ## 0.4.6 -- Fixes [compatibility issue with `mkdocs-git-revision-date-localized-plugin`](https://github.com/spotify/mkdocs-monorepo-plugin/issues/12) +- Fixes [compatibility issue with `mkdocs-git-revision-date-localized-plugin`](https://github.com/backstage/mkdocs-monorepo-plugin/issues/12) ## 0.4.5 @@ -26,7 +30,7 @@ ## 0.4.3 -- Fixed bug with trailing slash in Windows ([#9](https://github.com/spotify/mkdocs-monorepo-plugin/pull/9)) +- Fixed bug with trailing slash in Windows ([#9](https://github.com/backstage/mkdocs-monorepo-plugin/pull/9)) - Fixed bug with README ## 0.4.1 diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 39063e5..45dc42d 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -14,7 +14,7 @@ We welcome contributions! We believe that by fostering a healthy, inclusive, and This part should be easy. If it's not, let us know! The first thing you'll want to do is import the repository and open up the directory. ```terminal -$ git clone git@github.com:spotify/mkdocs-monorepo-plugin.git +$ git clone git@github.com:backstage/mkdocs-monorepo-plugin.git ``` Then using the `--editable` flag, you can install the package locally. This points the actual plugin to the folder which allows you to make changes dynamically without having to re-install it every time you want to test a change. diff --git a/docs/index.md b/docs/index.md index b995a77..967a50f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ -# spotify/mkdocs-monorepo-plugin +# backstage/mkdocs-monorepo-plugin -[![](https://github.com/spotify/mkdocs-monorepo-plugin/workflows/Build%2C%20Test%20%26%20Deploy/badge.svg)](https://github.com/spotify/mkdocs-monorepo-plugin/actions) +[![](https://github.com/backstage/mkdocs-monorepo-plugin/workflows/Build%2C%20Test%20%26%20Deploy/badge.svg)](https://github.com/backstage/mkdocs-monorepo-plugin/actions) [![PyPI](https://img.shields.io/pypi/v/mkdocs-monorepo-plugin)](https://pypi.org/project/mkdocs-monorepo-plugin/) ![](https://img.shields.io/badge/lifecycle-beta-509bf5.svg) [![PyPI - License](https://img.shields.io/pypi/l/mkdocs-monorepo-plugin)](LICENSE) @@ -31,7 +31,7 @@ $ pip install mkdocs-monorepo-plugin ## Usage -Take a look at [our sample project](https://github.com/spotify/mkdocs-monorepo-plugin/tree/master/sample-docs) or do the following: +Take a look at [our sample project](https://github.com/backstage/mkdocs-monorepo-plugin/tree/master/sample-docs) or do the following: - In the root, add the `monorepo` to your `plugins` key in `mkdocs.yml` - Create a subfolder, with a `mkdocs.yml` with a `site_name` and `nav`, as well as a `docs/` folder with an `index.md` @@ -121,7 +121,7 @@ $ tree . ## License -Released under the Apache 2.0 License. See [here](https://github.com/spotify/mkdocs-monorepo-plugin/blob/master/LICENSE) for more details. +Released under the Apache 2.0 License. See [here](https://github.com/backstage/mkdocs-monorepo-plugin/blob/master/LICENSE) for more details. ## Contributing diff --git a/mkdocs.yml b/mkdocs.yml index 4c814dd..33de2fb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,8 +5,8 @@ site_description: | copyright: 'Copyright © 2019 Spotify AB' # Repository -repo_name: 'spotify/mkdocs-monorepo-plugin' -repo_url: 'https://github.com/spotify/mkdocs-monorepo-plugin' +repo_name: 'backstage/mkdocs-monorepo-plugin' +repo_url: 'https://github.com/backstage/mkdocs-monorepo-plugin' # Theme theme: @@ -43,4 +43,4 @@ nav: - Contributing: CONTRIBUTING.md - Code of Conduct: CODE-OF-CONDUCT.md - Changelog: CHANGELOG.md - - GitHub Source Code: https://github.com/spotify/mkdocs-monorepo-plugin + - GitHub Source Code: https://github.com/backstage/mkdocs-monorepo-plugin diff --git a/setup.py b/setup.py index 0a8963c..30dfb44 100644 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ import setuptools setuptools.setup( name='mkdocs-monorepo-plugin', - version='0.4.10', + version='0.4.11', description='Plugin for adding monorepository support in Mkdocs.', long_description=""" This introduces support for the !include syntax in mkdocs.yml, allowing you to import additional Mkdocs navigation. @@ -11,7 +11,7 @@ setuptools.setup( This is built and maintained by the engineering community at Spotify. """, # noqa: E501 keywords='mkdocs monorepo', - url='https://github.com/spotify/mkdocs-monorepo-plugin', + url='https://github.com/backstage/mkdocs-monorepo-plugin', author='Bilawal Hameed', author_email='bil@spotify.com', license='Apache-2.0',