Unverified Commit 9ad79479 authored by Kelvin Rodriguez's avatar Kelvin Rodriguez Committed by GitHub
Browse files

Update Readme and remove gitlab references. (#7) 

* Update README.md to remove gitlab references

* Swapped gitlab url with GitHub on docs/index.md

* Added badge
parent 339a2efc

README.md

+19 −12
Original line number Diff line number Diff line 
# asc-public-docs

![Static Badge](https://img.shields.io/badge/docs-USGS%20Astro-blue?style=flat-square&link=https%3A%2F%2Fastrogeology.usgs.gov%2Fdocs%2F)



## Getting started



### Cloning and Rendering the Docs Locally



```bash

# 1. Clone the repository to your local machine:   

git clone git@code.usgs.gov:astrogeology/asc-public-docs.git

# 1. Create a fork of the repository (the fork button is on the upper right corner on GitHub)



# 2. Clone the repository to your local machine, replace <fork url> with your own fork.   

git clone <fork url>

cd asc-public-docs/



# 2. Create a branch to track your work

# 3. Create a branch to track your work

git checkout -b your-branch-name 



# 3. install dependencies 

# 4. install dependencies 

pip install -r requirements.txt



# 4. Make your changes to the code 

# 5. Make your changes to the code

# See "Adding Your Files" in the readme for details

# ...



# 5. Preview your changes, in the root of the repo run

# 6. Preview your changes, in the root of the repo run

mkdocs serve

```



# 6. Push your changes to the branch

To contribute changes back in: 



```bash

# 1. push changes back into your fork

git push origin your-branch-name



# Create a PR on this repository 

```



### Adding your files

### Adding Your Files



> See [mkdocs material docs](https://squidfunk.github.io/mkdocs-material/getting-started/) for information on how to work with mkdoc's material theme and it's features.
@@ -47,8 +56,6 @@ git push origin your-branch-name 
1. The continuous deployment system should automatically deploy your new changes. 

1. Celebrate your contribution! :tada:







## Understanding The Doc System



Contributors should consider writing new docs under one of our four categories:

docs/index.md

+1 −3
Original line number Diff line number Diff line
@@ -57,7 +57,5 @@ Before you consider contributing new documentation, ask yourself what category i 


Regarding software manuals, issues or contributions should be addressed to the repository for that specific project. The software manuals should have links to their repositories. 



You can submit any issues (e.g., addressing grammar errors, factual inacuracies) and find more info on how to contribute new docs through the site's [git repository](https://code.usgs.gov/astrogeology/asc-public-docs). If you find an issue somewhere in the repo, we strongly encourage users to also submit a change to the git repository to be reviewed, merged, and deployed. 





You can submit any issues (e.g., addressing grammar errors, factual inacuracies) and find more info on how to contribute new docs through the site's [git repository](https://github.com/DOI-USGS/asc-public-docs.git). If you find an issue somewhere in the repo, we strongly encourage users to also submit a change to the git repository to be reviewed, merged, and deployed.