Add guidelines on the use of example URLs in the Contributor Guide

Bug #1611176 reported by Darren Chan
10
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-manuals
Fix Released
Wishlist
Alexandra Settle

Bug Description

Based on a discussion with Brian Rosmaita:

1. For consistency, add guidelines to the Contributor Guide on the use of
example URLs in openstack-manuals and project documentation. Example.org is reserved by IANA for example URLs, so perhaps use the convention "project_name", then "openstack", followed by "example.org". For example:

http://glance.openstack.example.org/

2. Update example URLs in openstack-manuals to follow the above convention.

Darren Chan (dazzachan)
tags: added: contributor-guide
Darren Chan (dazzachan)
description: updated
Changed in openstack-manuals:
status: New → Triaged
importance: Undecided → Medium
Changed in openstack-manuals:
importance: Medium → Wishlist
assignee: nobody → Alexandra Settle (alexandra-settle)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-manuals (master)

Fix proposed to branch: master
Review: https://review.openstack.org/421392

Changed in openstack-manuals:
status: Triaged → In Progress
Changed in openstack-manuals:
assignee: Alexandra Settle (alexandra-settle) → Maria Zlatkova (mzlatkova)
Changed in openstack-manuals:
assignee: Maria Zlatkova (mzlatkova) → Andreas Jaeger (jaegerandi)
Changed in openstack-manuals:
assignee: Andreas Jaeger (jaegerandi) → Alexandra Settle (alexandra-settle)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-manuals (master)

Reviewed: https://review.openstack.org/421392
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=57da5de0ab538e90924e69801440a7b19a0b9f01
Submitter: Jenkins
Branch: master

commit 57da5de0ab538e90924e69801440a7b19a0b9f01
Author: Alexandra Settle <email address hidden>
Date: Tue Jan 17 17:18:00 2017 +0000

    Add guidelines on the use of example URLs

    Change-Id: If83e0225e540dd1b6c88134737b50213485dd720
    Partial-bug: 1611176

Changed in openstack-manuals:
status: In Progress → Fix Released
Revision history for this message
Alexandra Settle (alexandra-settle) wrote :

Hi Iswarya,

This bug was not entire fixed, as you can see above I implemented a partial-fix.

The second half of this proposal: "Update example URLs in openstack-manuals to follow the above convention." Still needs to be carried out.

Changed in openstack-manuals:
status: Fix Released → Confirmed
assignee: Alexandra Settle (alexandra-settle) → nobody
milestone: none → ocata
Changed in openstack-manuals:
assignee: nobody → Zhenyu Zheng (zhengzhenyu)
Lana (loquacity)
Changed in openstack-manuals:
milestone: ocata → pike
Poonam Mishra (mish24)
Changed in openstack-manuals:
assignee: Zhenyu Zheng (zhengzhenyu) → Poonam Mishra (mish24)
Changed in openstack-manuals:
status: Confirmed → Fix Released
assignee: Poonam Mishra (mish24) → Alexandra Settle (alexandra-settle)
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.