pcdshub / pcdshub.github.io

Home page for PCDS Python tools

pcdshub.github.io

Home page for PCDS Python tools

How to Contribute

In order to publish the documentation with GitHub Pages the generated HTML documentation needs to be kept on the "master" branch of the repository. To work around this the file the conventional Sphinx .rst files that instruct the build are kept on branch "source". If you would like to contribute to the documentation:

1. Fork this repository then check it out on your machine
2. Create a branch from the "source" branch contained within this repository

# Add the original repository as a remote
git remote add pcds https://github.com/pcdshub/pcdshub.github.io
# Fetch all the branches
git fetch --all
# Create your own source branch to track the original source
git checkout --track pcds/source
# Create your own feature branch
git checkout -b my_doc_change

3. Create a Pull Request to merge your changes with the "source" branch of this repository. Changes will be automatically updated after the Travis job completes.

pcdshub.github.io's Issues

Move this site to confluence

• Move content from this repository to PCDS Confluence (at @slacAWallace 's request)
• Replace each existing page with a link / redirect to new confluence pages
• Update those confluence pages (per #18 they are rather out-of-date)
• Add a link to each of our projects linking to our style/contribution guidelines

As nice as this repository is with its sphinx documentation, we rarely touch it. It would be nice to have it in our confluence space where we can collaboratively update things. It may lead to more frequent updates, too.

(cc @tangkong @slacAWallace )

Update overview with new repositories

This includes only repositories that are hosted on pcdshub is actually a lie

This page is probably due for an update soon anyway

Originally posted by @ZLLentz in #15

Need instructions for making a personal dev build of the greater "hutch-python" API

It'd be nice if there were instructions for how to get your own checkouts of pcds modules and databases into a python/hutch-python session for working on development changes.

i.e. a maintainable way to get your modules to talk to each other without hacking your $PATH to pieces.

For github/conda noobs like myself this is daunting and feels like a barrier for entry to the esteemed development club

Update commit guidelines link

Old link is broken
New link is https://numpy.org/doc/stable/dev/development_workflow.html#writing-the-commit-message

Fix up documentation deployment

Until we get #19 done (or even after), we should make an effort to keep pcdshub.github.io up-to-date.

#20 recently brought in some fixes to the links which we should propagate to the deployed site.

Conda install instructions bug out

conda env create -n myenvname -f /reg/g/pcds/pyps/conda/pcds-envs/pcds.yaml

Can throw an error if the user doesn't have write permissions in /reg/g/pcds/pyps/conda/pcds-envs because it tries to create a temporary file (!!?)

Make a more robust Travis CI configuration

1. Build the documentation on all Travis runs but only push if on pcdshub/source branch.
2. If we fail to build the docs do not push to pcds/master.

Add Overview of Packages and Pcdshub

• Start from high-level applications
• Explain what makes the gears turn at a high-level
• Go through each module and explain the motivation behind the existence and how it fits into other modules.

Revisit and revise this entire site

We should go back through and clean this up. It hasn't been updated since 2020. There are small things like recommending cloning from the https:// address and probably larger things too.