Commit Graph

24 Commits

Author SHA1 Message Date
ljhuang 476c5f89c7 Changed py39 from py27 in tox
Changed py39 from py27 in tox for contributing doc

Change-Id: Ia079b7b7f5d96858c7dfe4b3d103c0efd86ae68b
2022-07-29 10:26:28 +08:00
Lingxian Kong fc09de1409 Doc: move from freenode to OFTC
Change-Id: Ie398a633af429bf726f3b1ee85c93a1834c601b7
2021-06-01 08:49:13 +12:00
yangyong 1d3db54fbf fix bug report url
since we don't use launchpad to report bugs anymore,replace it with
storyboard.openstack.org

Change-Id: Ifa456c62c4fed197954cb7f7b2aaf0328a00d6a3
2019-09-03 03:03:27 +00:00
ZhongShengping 6a5afea40a Move to opendev
1.Use opendev.org instead of git.openstack.org.
2.Use review.opendev.org instead of review.openstack.org.

Change-Id: I8e9da8fbb04bdec42a0b2f012f6a38b8ee413b27
2019-04-24 16:08:08 +08:00
Marcin Piwowarczyk f73649412d Extend contribution doc by IRC contact details
Add details how to contact with trove members over IRC channel.

Change-Id: I00ee60812c6a46f26c7eba24711941d9b5362c96
2018-11-07 16:05:54 +01:00
melissaml 1a999f084b Update URLs in documents according to document migration
Change-Id: I4ef8a26df071746b6855a6a278840abdd77f2607
2017-11-03 17:17:01 +08:00
Jenkins 3d3181f56f Merge "Typo fix: encouter => encounter, lastest => latest" 2017-02-07 04:13:05 +00:00
Andreas Jaeger 515afe5323 Prepare for using standard python tests
Add simple script to setup mysql and postgresql databases, this script
can be run by users during testing and will be run by CI systems for
specific setup before running unit tests.

This allows to change in project-config the python-db jobs to
python-jobs since python-jobs will call this script initially.

Update CONTRIBUTING for this.

See also
http://lists.openstack.org/pipermail/openstack-dev/2016-November/107784.html

Change-Id: I3463e75057d0d4544f6a0212da888759ab5e171b
Needed-By: I92e6e6502c2c516babf2bf66f3514875f77c460e
2017-02-02 12:10:40 +00:00
Anh Tran fd877531d6 Typo fix: encouter => encounter, lastest => latest
Change-Id: Ie78dc6427213ce4ead696a5649bc32bceac68c3a
2017-01-26 11:15:12 +07:00
Amrith Kumar 36ba1c8a2d add section on code review priority
This section summarizes some discussions at the Barcelona summit.

Change-Id: Ic6d81f9ee95ed24512b57669ecb1ad036ab87944
2016-11-01 11:11:14 -04:00
ChangBo Guo(gcb) dceb26e485 Fix some typos in doc and comments
Change-Id: I7afe1d5851878fa392c46c7654e984e73de4246c
2016-10-04 06:47:29 +08:00
Amrith Kumar ca95916241 update contributing.rst to reflect release notes and bugs
Hitherto we have tried to enforce the requirement that changes have
Launchpad bugs. More openstack projects have moved away from this
requirement and it may be time for Trove to do the same.

We use reno for release notes and therefore if a release note is not
specified in the commit, it will not make it to the official release
notes page. We should therefore require release notes for all user
visible changes.

Change-Id: If72fc47c1d699b20a85574f5945ecff35cc0d008
2016-09-22 14:17:42 +00:00
Amrith Kumar a2d336de2a improve pylint; generate errors and config in sorted order
Since the config is not in a deterministic order makes it hard to
compare two config's and see what changed. Personally, I'm not
positive I understand this use-case; i.e. you have an existing config
file, you save it, and then rebuild and then diff the two files. I'd
have thought you'd just run check and the output of the tool was the
diff.

I however do see the value in sorting the file so that when someone
submits a change that includes a change to the config, reviewers can
see more easily what the change is doing.

Similarly, the output from pylint (errors) are generated one file at a
time and os.walk makes no guarantee of deterministic order. So we
should collect all errors (across all files) and then print an ordered
list for human consumption.

The intent is also to make pylint voting soon (in master). the changes
to contributing.rst and tox.ini are to make that easier. The config
file has also been sorted in place.

This change was motivated by an email exchange with Peter so I am
marking him as a co-conspirator.

The line numbers were removed from the tools/trove-pylint.config file
as these would change whenever the line numbers in the file changed
(since they are currently not being used in the comparison; they can
be re-added if deemed necessary at the cost of having every 'rebuild'
run create a different file).

The tools/trove-pylint.config was regenerated as well, since the
remaining two errors seem to be innocuous:

  ERROR: trove/taskmanager/manager.py 392: E1101 no-member,
  Manager.upgrade: Instance of 'BuiltInstance' has no 'upgrade' member
  (new method introduced by instance upgrade; other BuiltInstance
  member errors are already ignored.)

and

  ERROR: trove/guestagent/datastore/experimental/postgresql/service/
  access.py 80: E1101 no-member, PgSqlAccess.list_access: Instance ofi
  'PgSqlAccess' has no '_find_user' member
  (this is due to the fact that PostgreSQL is spread over multiple
  files and pylint should cease to complain once
  https://review.openstack.org/#/c/346082/ lands.)

Change-Id: I910c738d3845b7749e57910f76523150ec5a5bff
Closes-Bug: #1625158
Closes-Bug: #1625245
Co-Authored-By: Peter Stachowski <peter@tesora.com>
2016-09-19 21:04:14 +00:00
Amrith Kumar 3b0d1ea25d Adds the api-ref migrated RST + YAML files
With this email[0], you must migrate API reference docs into RST. The
conf.py and the tox environment are also cribbed from nova.

Still need to retain the install_command in tox.ini, otherwise the
api-ref job fails.

[0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html

Co-Authored-By: Anne Gentle <agentle@cisco.com>
Co-Authored-By: Amrith Kumar <amrith@tesora.com>

Change-Id: I3315261aa18729fa7a6aa79d4a1d6c24de1e2c6b
2016-08-17 17:46:41 -04:00
Amrith Kumar ddac516c85 Update CONTRIBUTING.rst
Updated CONTRIBUTING.rst to reflect discussions at mid-cycle regarding
abandonment of changes that are languishing in the gerrit review
system.

Change-Id: Ie9d22b01d09c2cdb250abd0596c0216ec457df4d
2016-07-31 07:33:27 -04:00
Amrith Kumar 389b464bf8 Document house rules for approving changes
Document house rules for approving changes and a relaxation that we
will adopt for the newton release cycle.

Change-Id: Icc9b62740bcf5a604c492b5e36a970c93b7e8fc9
2016-06-22 14:28:41 -04:00
DeepaJon 6539445f01 Update Trove's README
Updated the README.rst, In which updated about trove, getting
started, python client for trove and reference, Removed the Usage
for integration testing Tests and moved into CONTRIBUTION.rst
Taken reference from other component's README.rst file.

Change-Id: Ic3ce38155ecb120fc6fde1098fabb60be5383a64
Closes-Bug: #1572224
2016-05-04 15:48:55 +05:30
Abitha Palaniappan a67e8df991 Update CONTRIBUTING.RST file
I'm updating to reflect the discussion at the mid-cycle.

Change-Id: I31fca6d8006531f9d61480ea70aa69f8047a36dc
2015-02-04 11:10:28 -08:00
sarvesh-ranjan cdfdc5cd64 Spelling errors fixed
Change-Id: I7d2eec61cb4f02819dd42900146739acd9c65cc4
2015-01-22 10:53:48 -08:00
Jenkins ae0488773c Merge "Clean up github references from docs" 2014-12-08 21:29:25 +00:00
Monty Taylor 28e8fcf0ee Clean up github references from docs
OpenStack hosts things in places that are not github. Also, it seems
that there is a big blob of unrelated readme in the README file.

Closes-Bug: 1399839
Change-Id: I70cc6772b50591c4b3badd6c92567a7a6541bacf
2014-12-05 23:24:53 -08:00
Jeremy Stanley f7b4e8f13d Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: Ic33174d053274ab980c14da03b8394bfaf5375d3
2014-12-05 03:30:41 +00:00
Amrith Kumar 52b78a9d87 Update contributing.rst to include guidelines on Code Review
An important part of contributing to the Trove project is to review
changes proposed by others. To reflect the value of this activity, and
provide some guidelines on how the Trove project would like reviews to
be conducted, I have updated the contributing.rst file with a summary
of some conversations at the mid-cycle meetup.

The intent is that reviews of this proposed change will be a
discussion not only of the summary that I have attempted to capture,
but also of the change(s) being proposed.

I've opted to provide only rough guidelines and not provide exhaustive
examples of "good" and "bad" reviews (the format used by, for example,
the commit message guidelines) because the intent is not to create
rigid and cumbersome process but rather to provide guidelines that
reflect the desired purpose of the review process.

It is acceptable to -1 this change if you find typographical errors,
or have suggestions on the formatting of the document ;)

Change-Id: I09432c335282c17974cb62b6f77cd00ebcdda21f
2014-10-14 14:23:39 +00:00
liuqing 9ef1c3737f Add CONTRIBUTING.rst
There is no CONTRIBUTING.rst file, the patch will add it.

Change-Id: I279ef20612e695244456e36399d0d908642f85d8
Closes-Bug: #1337182
2014-07-03 14:59:57 +08:00