Commit bbed3fa7 authored by BO ZHANG's avatar BO ZHANG 🏀
Browse files

updated doc: author info and docker info

parent d9f64d35
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -23,7 +23,7 @@ sys.path.append(os.path.abspath('./packages/'))

project = 'A Guide for CSST DAS Developers'
copyright = '2022, CSST DAS Team'
author = 'CSST DAS Team'
author = 'Bo Zhang'

# The full version, including alpha/beta/rc tags
release = '0.0.1beta'
+11 −0
Original line number Diff line number Diff line
@@ -45,6 +45,17 @@ The guide for astropy-affiliated package development
The guide for LSST developers
   https://developer.lsst.io/

----

:Author: Bo Zhang
:Institute: National Astronomical Observatories, CAS (NAOC)
:Contact: bozhang@nao.cas.cn
:Last updated: 2022-10-11
:Version: 0.0.1beta
:Copyright: CSST DAS Team

----


.. toctree::
   :hidden:
+47 −3
Original line number Diff line number Diff line
@@ -7,7 +7,51 @@ Using ``Jenkins``
to be updated


Using ``docker``
----------------
Base ``docker`` image
---------------------

to be updated
 No newline at end of file
The CSST pipeline will be dockerized from the base image ``continuumio/anaconda3``:

    - https://hub.docker.com/r/continuumio/anaconda3

The basic information is shown below

.. code-block::

    # cat /etc/issue
    Debian GNU/Linux 11 \n \l

    # which python
    /opt/conda/bin/python
    # which conda
    /opt/conda/bin/conda
    # which pip
    /opt/conda/bin/pip
    # conda info

         active environment : None
           user config file : /root/.condarc
     populated config files :
              conda version : 4.12.0
        conda-build version : 3.21.8
             python version : 3.9.12.final.0
           virtual packages : __linux=5.10.124=0
                              __glibc=2.31=0
                              __unix=0=0
                              __archspec=1=aarch64
           base environment : /opt/conda  (writable)
          conda av data dir : /opt/conda/etc/conda
      conda av metadata url : None
               channel URLs : https://repo.anaconda.com/pkgs/main/linux-aarch64
                              https://repo.anaconda.com/pkgs/main/noarch
                              https://repo.anaconda.com/pkgs/r/linux-aarch64
                              https://repo.anaconda.com/pkgs/r/noarch
              package cache : /opt/conda/pkgs
                              /root/.conda/pkgs
           envs directories : /opt/conda/envs
                              /root/.conda/envs
                   platform : linux-aarch64
                 user-agent : conda/4.12.0 requests/2.27.1 CPython/3.9.12 Linux/5.10.124-linuxkit debian/11 glibc/2.31
                    UID:GID : 0:0
                 netrc file : None
               offline mode : False
 No newline at end of file
+14 −0
Original line number Diff line number Diff line
@@ -132,3 +132,17 @@ a code reviewer is required to merge approved code revisions into ``main`` branc
.. _CSST DAS GitLab: https://csst-tb.bao.ac.cn/code
.. _GitLab: https://about.gitlab.com/
.. _csst-l1: https://csst-tb.bao.ac.cn/code/csst-l1


Code review
-----------

Starting from C7, developers of all packages should NOT directly push any code
to *main* branch which is protected.
A reviewer is needed to approve the committed modifications before
merging into the *main* branch.

Developers should switch to a ``dev`` branch before doing anything.
Then commit code and push them to ``dev`` branch.