generated from AdobeDocs/dev-site-documentation-template
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
binsler
committed
Dec 9, 2024
1 parent
24f5c85
commit 1da3c86
Showing
1 changed file
with
2 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,67 +1,3 @@ | ||
# Adobe I/O Documentation Template | ||
# ReadMe | ||
|
||
This is a site template built with the [Adobe I/O Theme](https://github.com/adobe/aio-theme). | ||
|
||
View the [demo](https://adobedocs.github.io/dev-site-documentation-template/) running on Github Pages. | ||
|
||
## Where to ask for help | ||
|
||
The slack channel #adobeio-onsite-onboarding is our main point of contact for help. Feel free to join the channel and ask any questions. | ||
|
||
## How to develop | ||
|
||
For local development, simply use : | ||
|
||
```shell | ||
$ yarn install | ||
$ yarn dev | ||
``` | ||
|
||
For the developer documentation, read the following sections on how to: | ||
|
||
- [Arrange the structure content of your docs](https://github.com/adobe/aio-theme#content-structure) | ||
- [Link to pages](https://github.com/adobe/aio-theme#links) | ||
- [Use assets](https://github.com/adobe/aio-theme#assets) | ||
- [Set global Navigation](https://github.com/adobe/aio-theme#global-navigation) | ||
- [Set side navigation](https://github.com/adobe/aio-theme#side-navigation) | ||
- [Use content blocks](https://github.com/adobe/aio-theme#jsx-blocks) | ||
- [Use Markdown](https://github.com/adobe/aio-theme#writing-enhanced-markdown) | ||
|
||
For more in-depth [instructions](https://github.com/adobe/aio-theme#getting-started). | ||
|
||
## How to test | ||
|
||
- To run the configured linters locally (requires [Docker](https://www.docker.com/)): | ||
|
||
```shell | ||
yarn lint | ||
``` | ||
|
||
> NOTE If you cannot use Docker, you can install the linters separately. In `.github/super-linter.env`, see which linters are enabled, and find the tools being used for linting in [Supported Linters](https://github.com/github/super-linter#supported-linters). | ||
- To check internal links locally | ||
|
||
```shell | ||
yarn test:links | ||
``` | ||
|
||
- To build and preview locally: | ||
|
||
```shell | ||
yarn start | ||
``` | ||
|
||
## How to deploy | ||
|
||
For any team that wishes to deploy to the developer.adobe.com and developer-stage.adobe.com websites, they must be in contact with the dev-site team. Teams will be given a path that will follow the pattern `developer.adobe.com/{product}/`. This will allow doc developers to setup their subpaths to look something like: | ||
|
||
```text | ||
developer.adobe.com/{product}/docs | ||
developer.adobe.com/{product}/community | ||
developer.adobe.com/{product}/community/code_of_conduct | ||
developer.adobe.com/{product}/community/contribute | ||
``` | ||
|
||
### Launching a deploy | ||
|
||
You can deploy using the GitHub actions deploy workflow see [deploy instructions](https://github.com/adobe/aio-theme#deploy-to-azure-storage-static-websites). | ||
There is going to be so much information here one day, you won't believe your eyes... |