Skip to content

Commit

Permalink
v0.8.2 docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
@izelnakri
izelnakri committed Jun 29, 2019
1 parent 060b781 commit 9b490ca
Show file tree
Hide file tree
Showing 26 changed files with 702 additions and 551 deletions.
5 changes: 3 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ The library source code is minimal and well tested. It is suggested to read the

```elixir
def deps do
[{:paper_trail, "~> 0.8.1"}]
[{:paper_trail, "~> 0.8.2"}]
end
```

Expand Down Expand Up @@ -185,7 +185,7 @@ You can specify setter/originator relationship to paper_trail versions with ```o
# For most applications originator should be the user since models can be updated/created/deleted by several users.
```

Note: You will need to recompile your deps after you have added the config for originator.
Note: You will need to recompile your deps after you have added the config for originator.

Then originator name could be used for querying and preloading. Originator setting must be done via ```:originator``` or originator name that is defined in the paper_trail configuration:

Expand Down Expand Up @@ -442,6 +442,7 @@ PaperTrail.get_versions(User, id, [prefix: tenant])
# Credits
Many thanks to:
- [Jose Pablo Castro](https://github.com/josepablocastro) - Built the repo configuration for paper_trail
- [Florian Gerhardt](https://github.com/FlorianGerhardt) - Fixed rare compile errors for PaperTrail repos
- [Alex Antonov](https://github.com/asiniy) - Original inventor of the originator feature
- [Moritz Schmale](https://github.com/narrowtux) - UUID primary keys feature
- [Jason Draper](https://github.com/drapergeek) - UUID primary keys feature
Expand Down
15 changes: 8 additions & 7 deletions doc/.build
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
dist/app-240d7fc7e5.css
dist/app-a0c90688fa.js
fonts/icomoon.eot
fonts/icomoon.svg
fonts/icomoon.ttf
fonts/icomoon.woff
dist/sidebar_items-54af3ecba9.js
dist/search_items-6c2e4c630f.js
dist/html-d9f58a6320b5bfa6dd77.css
dist/html-d9f58a6320b5bfa6dd77.js
dist/html/fonts/icomoon.eot
dist/html/fonts/icomoon.svg
dist/html/fonts/icomoon.ttf
dist/html/fonts/icomoon.woff
dist/sidebar_items-751b1548bc.js
api-reference.html
search.html
404.html
Expand Down
75 changes: 44 additions & 31 deletions doc/404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,43 +4,51 @@
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.19.1">
<title>404 – paper_trail v0.8.1</title>
<link rel="stylesheet" href="dist/app-240d7fc7e5.css" />
<meta name="generator" content="ExDoc v0.20.2">
<meta name="project" content="paper_trail v0.8.2">
<title>404 — paper_trail v0.8.2</title>
<link rel="stylesheet" href="dist/html-d9f58a6320b5bfa6dd77.css" />
<link rel="canonical" href="https://hexdocs.pm/paper_trail/404.html" />
<script src="dist/sidebar_items-54af3ecba9.js"></script>

<script src="dist/sidebar_items-751b1548bc.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-d9f58a6320b5bfa6dd77.js"></script>
</head>
<body data-type="extras">
<script>try { if(localStorage.getItem('night-mode')) document.body.className += ' night-mode'; } catch (e) { }</script>
<div class="main">

<button class="sidebar-button sidebar-toggle">
<span class="icon-menu" aria-hidden="true"></span>
<span class="sr-only">Toggle Sidebar</span>
</button>
<button class="sidebar-button night-mode-toggle">
<span class="icon-theme" aria-hidden="true"></span>
<span class="sr-only">Toggle Theme</span>
<span class="icon-menu" title="Collapse/expand sidebar"></span>
</button>
<section class="sidebar">

<a href="api-reference.html" class="sidebar-projectLink">
<div class="sidebar-projectDetails">
<h1 class="sidebar-projectName">
paper_trail </h1>
<h2 class="sidebar-projectVersion">
v0.8.1
</h2>
</div>
</a>

<section class="sidebar">
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button">
<span class="icon-search" aria-hidden="true"></span>
</button>
<input name="q" type="text" id="search-list" class="search-input" placeholder="Search" aria-label="Search" autocomplete="off" />
<button type="button" tabindex="-1" class="search-close-button">
<span class="icon-cross" title="Cancel search"></span>
</button>
<label class="search-label">
<input name="q" type="text" id="search-list" class="search-input" placeholder="Search..." aria-label="Search" autocomplete="off" />
</label>
</form>

<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>

<div class="sidebar-header">
<div class="sidebar-projectDetails">
<a href="api-reference.html" class="sidebar-projectName">
paper_trail </a>
<h2 class="sidebar-projectVersion">
v0.8.2
</h2>
</div>
</div>

<ul class="sidebar-listNav">
<li><a id="extras-list" href="#full-list">Pages</a></li>

Expand All @@ -57,31 +65,36 @@ <h2 class="sidebar-projectVersion">
<div class="content-outer">
<div id="content" class="content-inner">


<h2>Page not found</h2>

<p>Sorry, but the page you were trying to get to, does not exist. You
may want to try searching this site using the sidebar or using our
<a href="api-reference.html" title="API Reference">API Reference</a> page to find what
you were looking for.</p>
may want to try searching this site using the sidebar
or using our <a href="api-reference.html">API Reference</a> page
to find what you were looking for.</p>

<footer class="footer">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener">ExDoc</a> (v0.19.1),
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener">ExDoc</a> (v0.20.2),
</span>
<span class="line">
designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" rel="noopener" title="@dignifiedquire">Friedel Ziegelmayer</a>.
</span>
</span>
</p>
<p>
<button class="line footer-button night-mode-toggle">
Toggle night mode
</button>
<button class="line footer-button display-shortcuts-help">
Display keyboard shortcuts
</button>
</p>
</footer>
</div>
</div>
</section>
</div>
<script src="dist/app-a0c90688fa.js"></script>

</body>
</html>
101 changes: 54 additions & 47 deletions doc/Mix.Tasks.Papertrail.Install.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,43 +4,51 @@
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.19.1">
<title>papertrail.install – paper_trail v0.8.1</title>
<link rel="stylesheet" href="dist/app-240d7fc7e5.css" />
<meta name="generator" content="ExDoc v0.20.2">
<meta name="project" content="paper_trail v0.8.2">
<title>mix papertrail.install — paper_trail v0.8.2</title>
<link rel="stylesheet" href="dist/html-d9f58a6320b5bfa6dd77.css" />
<link rel="canonical" href="https://hexdocs.pm/paper_trail/Mix.Tasks.Papertrail.Install.html" />
<script src="dist/sidebar_items-54af3ecba9.js"></script>

<script src="dist/sidebar_items-751b1548bc.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-d9f58a6320b5bfa6dd77.js"></script>
</head>
<body data-type="tasks">
<script>try { if(localStorage.getItem('night-mode')) document.body.className += ' night-mode'; } catch (e) { }</script>
<div class="main">
<div class="main">

<button class="sidebar-button sidebar-toggle">
<span class="icon-menu" aria-hidden="true"></span>
<span class="sr-only">Toggle Sidebar</span>
</button>
<button class="sidebar-button night-mode-toggle">
<span class="icon-theme" aria-hidden="true"></span>
<span class="sr-only">Toggle Theme</span>
<span class="icon-menu" title="Collapse/expand sidebar"></span>
</button>
<section class="sidebar">

<a href="api-reference.html" class="sidebar-projectLink">
<div class="sidebar-projectDetails">
<h1 class="sidebar-projectName">
paper_trail </h1>
<h2 class="sidebar-projectVersion">
v0.8.1
</h2>
</div>
</a>

<section class="sidebar">
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button">
<span class="icon-search" aria-hidden="true"></span>
</button>
<input name="q" type="text" id="search-list" class="search-input" placeholder="Search" aria-label="Search" autocomplete="off" />
<button type="button" tabindex="-1" class="search-close-button">
<span class="icon-cross" title="Cancel search"></span>
</button>
<label class="search-label">
<input name="q" type="text" id="search-list" class="search-input" placeholder="Search..." aria-label="Search" autocomplete="off" />
</label>
</form>

<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>

<div class="sidebar-header">
<div class="sidebar-projectDetails">
<a href="api-reference.html" class="sidebar-projectName">
paper_trail </a>
<h2 class="sidebar-projectVersion">
v0.8.2
</h2>
</div>
</div>

<ul class="sidebar-listNav">
<li><a id="extras-list" href="#full-list">Pages</a></li>

Expand All @@ -57,10 +65,9 @@ <h2 class="sidebar-projectVersion">
<div class="content-outer">
<div id="content" class="content-inner">


<h1>
<small class="visible-xs">paper_trail v0.8.1</small>
mix papertrail.install </h1>
<small class="app-vsn">paper_trail v0.8.2</small>
mix papertrail.install </h1>



Expand All @@ -72,7 +79,6 @@ <h1 class="section-heading">
</a>
Summary
</h1>

<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
Expand All @@ -82,57 +88,58 @@ <h2>
<a href="#run/1">run(args)</a>
</div>
<div class="summary-synopsis"><p>A task needs to implement <code class="inline">run</code> which receives
a list of command line args</p>
</div>
a list of command line args.</p></div>
</div>
</div>

</section>



<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Functions
</h1>
<div class="detail" id="run/1">
<div class="detail-header">
Functions </h1>
<div class="functions-list">
<section class="detail" id="run/1">
<div class="detail-header">
<a href="#run/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">run(args)</span>
</div>
<h1 class="signature">run(args)</span>
</div>
<section class="docstring">
<p>A task needs to implement <code class="inline">run</code> which receives
a list of command line args.</p>
<p>Callback implementation for <a href="https://hexdocs.pm/mix/Mix.Task.html#c:run/1"><code class="inline">Mix.Task.run/1</code></a>.</p>
</section>
</div>
</section>
</div>
</section>

<footer class="footer">
<footer class="footer">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener">ExDoc</a> (v0.19.1),
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener">ExDoc</a> (v0.20.2),
</span>
<span class="line">
designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" rel="noopener" title="@dignifiedquire">Friedel Ziegelmayer</a>.
</span>
</span>
</p>
<p>
<button class="line footer-button night-mode-toggle">
Toggle night mode
</button>
<button class="line footer-button display-shortcuts-help">
Display keyboard shortcuts
</button>
</p>
</footer>
</div>
</div>
</section>
</div>
<script src="dist/app-a0c90688fa.js"></script>

</body>
</html>

Loading

0 comments on commit 9b490ca

Please sign in to comment.