Skip to content

Commit

Permalink
Merge pull request #1 from HCL-TECH-SOFTWARE/feature/update-github-repo
Browse files Browse the repository at this point in the history
Update github repo in mkdocs.yml and readme
  • Loading branch information
marcvincentvista authored Dec 19, 2024
2 parents d048520 + 5f4f4ec commit c4014c6
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ Perform the following steps to install mkdocs and clone the git repository to up
- Follow the [MkDocs Installation guide](https://www.mkdocs.org/user-guide/installation/) to install [`MkDocs`](https://www.mkdocs.org/) and `pip`
- Install the required `mkdocs` plugins:
- `pip install -r requirements.txt`
- Clone the [digital-experience repository](https://github.com/HCL-TECH-SOFTWARE/digital-experience)
- Clone the [dx-compose-doc repository](https://github.com/HCL-TECH-SOFTWARE/dx-compose-doc)
- Update the markdown files in the `docs` folder
- Verify the changes by building the project locally [mkdocs serve](https://www.mkdocs.org/getting-started/#creating-a-new-project)
- Commit the changes
- Create and submit a [Pull Request](https://github.com/HCL-TECH-SOFTWARE/digital-experience/pulls)
- Create and submit a [Pull Request](https://github.com/HCL-TECH-SOFTWARE/dx-compose-doc/pulls)
- Await the PR to be reviewed, merged, and built

## Set up github email notification
Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ extra:
property: G-7LF0XY95M1

# Repository
repo_url: https://github.com/HCL-TECH-SOFTWARE/digital-experience
repo_name: HCL-TECH-SOFTWARE/digital-experience
repo_url: https://github.com/HCL-TECH-SOFTWARE/dx-compose-doc
repo_name: HCL-TECH-SOFTWARE/dx-compose-doc
edit_uri: edit/main/docs

# Customization
Expand Down

0 comments on commit c4014c6

Please sign in to comment.