Changeset - 5a3417b6fcf2
Parent rev.
Child rev.
[Not reviewed]
stable
0 3 0
Thomas De Schampheleire - 5 years ago 2020-10-04 20:41:49
thomas.de_schampheleire@nokia.com
docs/readme: remove more references to Bitbucket
3 files changed with 5 insertions and 36 deletions:
README.rst
2
3
docs/contributing.rst
3
32
docs/index.rst
1
0 comments (0 inline, 0 general)
README.rst
➞
Show inline comments
 
@@ -126,27 +126,26 @@ Community
 
like to see.
 

			




	
	
	
		
 
Get in touch with the rest of the community:

			




	
	
	
		
 

			




	
	
	
		
 
- Join the mailing list users and developers -- see

			




	
	
	
		
 
  http://lists.sfconservancy.org/mailman/listinfo/kallithea-general.

			




	
	
	
		
 

			




	
	
	
		
 
- Use IRC and join #kallithea on FreeNode (irc.freenode.net) or use

			




	
	
	
		
 
  http://webchat.freenode.net/?channels=kallithea.

			




	
	
	
		
 

			




	
	
	
		
 
- Follow Kallithea on Twitter, **@KallitheaSCM**.

			




	
	
	
		
 

			




	
	
	
		
 
- The `old issue tracker <https://bitbucket.org/conservancy/kallithea/issues>`_

			




	
	
	
		
 
  is defunct after it was deleted by Bitbucket_. For now, please report issues

			




	
	
	
		
 
  on the mailing list.

			




	
	
	
		
 
- Please report issues on the mailing list. An archive of the old issue tracker

			




	
	
	
		
 
  is available at: https://kallithea-scm.org/bitbucket-archive/issues/index.html

			




	
	
	
		
 

			




	
	
	
		
 
   .. note::

			




	
	
	
		
 

			




	
	
	
		
 
       Please try to read the documentation before posting any issues,

			




	
	
	
		
 
       especially the **troubleshooting section**

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Online documentation

			




	
	
	
		
 
--------------------

			




	
	
	
		
 

			




	
	
	
		
 
Online documentation for the current version of Kallithea is available at

			




	
	
	
		
 
https://docs.kallithea-scm.org/en/stable/. Documentation for the current development

			




        

    


    
    

    

        

                

                    docs/contributing.rst
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -6,56 +6,49 @@ Contributing to Kallithea

			




	
	
	
		
 

			




	
	
	
		
 
Kallithea is developed and maintained by its users. Please join us and scratch

			




	
	
	
		
 
your own itch.

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Infrastructure

			




	
	
	
		
 
--------------

			




	
	
	
		
 

			




	
	
	
		
 
The main repository is hosted on Our Own Kallithea (aka OOK) at

			




	
	
	
		
 
https://kallithea-scm.org/repos/kallithea/, our self-hosted instance

			




	
	
	
		
 
of Kallithea.

			




	
	
	
		
 

			




	
	
	
		
 
For now, we use Bitbucket_ for `pull requests`_ and `issue tracking`_. The

			




	
	
	
		
 
issue tracker is for tracking bugs, not for support, discussion, or ideas --

			




	
	
	
		
 
please use the `mailing list`_ or :ref:`IRC <readme>` to reach the community.

			




	
	
	
		
 
Please use the `mailing list`_ to send patches or report issues.

			




	
	
	
		
 

			




	
	
	
		
 
We use Weblate_ to translate the user interface messages into languages other

			




	
	
	
		
 
than English. Join our project on `Hosted Weblate`_ to help us.

			




	
	
	
		
 
To register, you can use your Bitbucket or GitHub account. See :ref:`translations`

			




	
	
	
		
 
for more details.

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Getting started

			




	
	
	
		
 
---------------

			




	
	
	
		
 

			




	
	
	
		
 
To get started with Kallithea development::

			




	
	
	
		
 

			




	
	
	
		
 
        hg clone https://kallithea-scm.org/repos/kallithea

			




	
	
	
		
 
        cd kallithea

			




	
	
	
		
 
        python3 -m venv ../kallithea-venv

			




	
	
	
		
 
        source ../kallithea-venv/bin/activate

			




	
	
	
		
 
        pip install --upgrade pip setuptools

			




	
	
	
		
 
        pip install --upgrade -e . -r dev_requirements.txt python-ldap python-pam

			




	
	
	
		
 
        kallithea-cli config-create my.ini

			




	
	
	
		
 
        kallithea-cli db-create -c my.ini --user=user --email=user@example.com --password=password --repos=/tmp

			




	
	
	
		
 
        kallithea-cli front-end-build

			




	
	
	
		
 
        gearbox serve -c my.ini --reload &

			




	
	
	
		
 
        firefox http://127.0.0.1:5000/

			




	
	
	
		
 

			




	
	
	
		
 
If you plan to use Bitbucket_ for sending contributions, you can also fork

			




	
	
	
		
 
Kallithea on Bitbucket_ first (https://bitbucket.org/conservancy/kallithea) and

			




	
	
	
		
 
then replace the clone step above by a clone of your fork. In this case, please

			




	
	
	
		
 
see :ref:`contributing-guidelines` below for configuring your fork correctly.

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Contribution flow

			




	
	
	
		
 
-----------------

			




	
	
	
		
 

			




	
	
	
		
 
Starting from an existing Kallithea clone, make sure it is up to date with the

			




	
	
	
		
 
latest upstream changes::

			




	
	
	
		
 

			




	
	
	
		
 
        hg pull

			




	
	
	
		
 
        hg update

			




	
	
	
		
 

			




	
	
	
		
 
Review the :ref:`contributing-guidelines` and :ref:`coding-guidelines`.

			




	
	
	
		
 

			




	
	
		
 
@@ -64,26 +57,25 @@ Guide`_ on the Mercurial wiki.

			




	
	
	
		
 

			




	
	
	
		
 
Now, make some changes and test them (see :ref:`contributing-tests`). Don't

			




	
	
	
		
 
forget to add new tests to cover new functionality or bug fixes.

			




	
	
	
		
 

			




	
	
	
		
 
For documentation changes, run ``make html`` from the ``docs`` directory to

			




	
	
	
		
 
generate the HTML result, then review them in your browser.

			




	
	
	
		
 

			




	
	
	
		
 
Before submitting any changes, run the cleanup script::

			




	
	
	
		
 

			




	
	
	
		
 
        ./scripts/run-all-cleanup

			




	
	
	
		
 

			




	
	
	
		
 
When you are completely ready, you can send your changes to the community for

			




	
	
	
		
 
review and inclusion. Most commonly used methods are sending patches to the

			




	
	
	
		
 
mailing list (via ``hg email``) or by creating a pull request on Bitbucket_.

			




	
	
	
		
 
review and inclusion, via the mailing list (via ``hg email``).

			




	
	
	
		
 

			




	
	
	
		
 
.. _contributing-tests:

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Running tests

			




	
	
	
		
 
-------------

			




	
	
	
		
 

			




	
	
	
		
 
After finishing your changes make sure all tests pass cleanly. Run the testsuite

			




	
	
	
		
 
by invoking ``py.test`` from the project root::

			




	
	
	
		
 

			




	
	
	
		
 
    py.test

			




	
	
	
		
 

			




	
	
		
 
@@ -146,36 +138,27 @@ To analyze performance, you could instal

			




	
	
	
		
 

			




	
	
	
		
 
.. _contributing-guidelines:

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Contribution guidelines

			




	
	
	
		
 
-----------------------

			




	
	
	
		
 

			




	
	
	
		
 
Kallithea is GPLv3 and we assume all contributions are made by the

			




	
	
	
		
 
committer/contributor and under GPLv3 unless explicitly stated. We do care a

			




	
	
	
		
 
lot about preservation of copyright and license information for existing code

			




	
	
	
		
 
that is brought into the project.

			




	
	
	
		
 

			




	
	
	
		
 
Contributions will be accepted in most formats -- such as pull requests on

			




	
	
	
		
 
Bitbucket, something hosted on your own Kallithea instance, or patches sent by

			




	
	
	
		
 
Contributions will be accepted in most formats -- such as commits hosted on your own Kallithea instance, or patches sent by

			




	
	
	
		
 
email to the `kallithea-general`_ mailing list.

			




	
	
	
		
 

			




	
	
	
		
 
When contributing via Bitbucket, please make your fork of

			




	
	
	
		
 
https://bitbucket.org/conservancy/kallithea/ `non-publishing`_ -- it is one of

			




	
	
	
		
 
the settings on "Repository details" page. This ensures your commits are in

			




	
	
	
		
 
"draft" phase and makes it easier for you to address feedback and for project

			




	
	
	
		
 
maintainers to integrate your changes.

			




	
	
	
		
 

			




	
	
	
		
 
.. _non-publishing: https://www.mercurial-scm.org/wiki/Phases#Publishing_Repository

			




	
	
	
		
 

			




	
	
	
		
 
Make sure to test your changes both manually and with the automatic tests

			




	
	
	
		
 
before posting.

			




	
	
	
		
 

			




	
	
	
		
 
We care about quality and review and keeping a clean repository history. We

			




	
	
	
		
 
might give feedback that requests polishing contributions until they are

			




	
	
	
		
 
"perfect". We might also rebase and collapse and make minor adjustments to your

			




	
	
	
		
 
changes when we apply them.

			




	
	
	
		
 

			




	
	
	
		
 
We try to make sure we have consensus on the direction the project is taking.

			




	
	
	
		
 
Everything non-sensitive should be discussed in public -- preferably on the

			




	
	
	
		
 
mailing list.  We aim at having all non-trivial changes reviewed by at least

			




	
	
	
		
 
one other core developer before pushing. Obvious non-controversial changes will

			




	
	
		
 
@@ -291,35 +274,23 @@ over the Kallithea web interface, allowi

			




	
	
	
		
 
  variables

			




	
	
	
		
 
* a list of executed database queries, including timing and result values

			




	
	
	
		
 

			




	
	
	
		
 
DebugBar is only activated when ``debug = true`` is set in the configuration

			




	
	
	
		
 
file. This is important, because the DebugBar toolbar will be visible for all

			




	
	
	
		
 
users, and allow them to see information they should not be allowed to see. Like

			




	
	
	
		
 
is anyway the case for ``debug = true``, do not use this in production!

			




	
	
	
		
 

			




	
	
	
		
 
To enable DebugBar, install ``tgext.debugbar`` and ``kajiki`` (typically via

			




	
	
	
		
 
``pip``) and restart Kallithea (in debug mode).

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
"Roadmap"

			




	
	
	
		
 
---------

			




	
	
	
		
 

			




	
	
	
		
 
We do not have a road map but are waiting for your contributions. Refer to the

			




	
	
	
		
 
wiki_ for some ideas of places we might want to go -- contributions in these

			




	
	
	
		
 
areas are very welcome.

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Thank you for your contribution!

			




	
	
	
		
 
--------------------------------

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
.. _Weblate: http://weblate.org/

			




	
	
	
		
 
.. _issue tracking: https://bitbucket.org/conservancy/kallithea/issues?status=new&status=open

			




	
	
	
		
 
.. _pull requests: https://bitbucket.org/conservancy/kallithea/pull-requests

			




	
	
	
		
 
.. _bitbucket: http://bitbucket.org/

			




	
	
	
		
 
.. _mailing list: http://lists.sfconservancy.org/mailman/listinfo/kallithea-general

			




	
	
	
		
 
.. _kallithea-general: http://lists.sfconservancy.org/mailman/listinfo/kallithea-general

			




	
	
	
		
 
.. _Hosted Weblate: https://hosted.weblate.org/projects/kallithea/kallithea/

			




	
	
	
		
 
.. _wiki: https://bitbucket.org/conservancy/kallithea/wiki/Home

			




	
	
	
		
 
.. _DebugBar: https://github.com/TurboGears/tgext.debugbar

			




	
	
	
		
 
.. _Quick Start: https://www.mercurial-scm.org/wiki/QuickStart

			




	
	
	
		
 
.. _Beginners Guide: https://www.mercurial-scm.org/wiki/BeginnersGuides

			




        

    


    
    

    

        

                

                    docs/index.rst
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -72,18 +72,17 @@ Developer guide

			




	
	
	
		
 

			




	
	
	
		
 
.. toctree::

			




	
	
	
		
 
   :maxdepth: 1

			




	
	
	
		
 

			




	
	
	
		
 
   contributing

			




	
	
	
		
 
   dev/i18n

			




	
	
	
		
 
   dev/dbmigrations

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
.. _python: http://www.python.org/

			




	
	
	
		
 
.. _django: http://www.djangoproject.com/

			




	
	
	
		
 
.. _mercurial: https://www.mercurial-scm.org/

			




	
	
	
		
 
.. _bitbucket: http://bitbucket.org/

			




	
	
	
		
 
.. _subversion: http://subversion.tigris.org/

			




	
	
	
		
 
.. _git: http://git-scm.com/

			




	
	
	
		
 
.. _celery: http://celeryproject.org/

			




	
	
	
		
 
.. _Sphinx: http://sphinx.pocoo.org/

			




	
	
	
		
 
.. _vcs: http://pypi.python.org/pypi/vcs

			




        

    



    


    



    



      

      





    
    0 comments (0 inline, 0 general)
    





    


  

  







  


    




    








    
        Server instance: clio-30421
    
    
        This site is powered by
            Kallithea 0.7.0,
        which is
        © 2010–2025 by various authors & licensed under GPLv3.
            – Support