Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
2ad049e3
Commit
2ad049e3
authored
Sep 21, 2020
by
Sarah Yasonik
Committed by
Amy Qualls (slowly returning after surgery)
Sep 21, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Revisions from technical writing team
Revise the new wording to meet GitLab tone and style.
parent
bf6872e4
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
16 additions
and
0 deletions
+16
-0
doc/development/reference_processing.md
doc/development/reference_processing.md
+16
-0
No files found.
doc/development/reference_processing.md
View file @
2ad049e3
...
...
@@ -77,6 +77,22 @@ a minimum implementation of `AbstractReferenceFilter` should define:
and an identifier, find the object. For example, this in a reference filter for
merge requests, this might be
`project.merge_requests.where(iid: iid)`
.
### Add a new reference prefix and filter
For reference filters for new objects, use a prefix format following the pattern
`^<object_type>#`
, because:
1.
Varied single-character prefixes are hard for users to track. Especially for
lower-use object types, this can diminish value for the feature.
1.
Suitable single-character prefixes are limited.
1.
Following a consistent pattern allows users to infer the existence of new features.
To add a reference prefix for a new object
`apple`
,which has both a name and ID,
format the reference as:
-
`^apple#123`
for identification by ID.
-
`^apple#"Granny Smith"`
for identification by name.
### Performance
#### Find object optimization
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment