You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: about/faq.md
+27-9Lines changed: 27 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ If you’re new to GitHub and open source in general, figuring out how to get se
35
35
***Company**: `Lawrence Livermore National Laboratory, @LLNL`.
36
36
***Location**: Your primary location.
37
37
{:.mb-3}
38
-
3. Add your `@LLNL` email address (and any aliases) to your [Email Settings](https://github.com/settings/emails) page. This will link any commits done via [your Git identity](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup#Your-Identity) to your GitHub account.
38
+
3. Add your `@llnl.gov` email address (and any aliases) to your [Email Settings](https://github.com/settings/emails) page. This will link any commits done via [your Git identity](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup#Your-Identity) to your GitHub account.
*[Learn how to set up 2FA at the Lab <iclass="fa fa-light fa-lock"></i>](https://dev.llnl.gov/security-access/2fa).
@@ -101,7 +101,7 @@ If you are an employee at LLNL and have 2FA enabled, you are eligible to join th
101
101
{% include components/accordion.html title='How do I join the LLNL organization on GitHub?' slug='join' content=accordionContent %}
102
102
103
103
{% capture accordionContent %}
104
-
Before content is placed into an LLNL GitHub.com repository, it should be reviewed and released via LLNL's Information Management (IM) process–even if you plan on setting the repository to *Private* instead of *Public*. All information produced by LLNL must follow the guidance set forth by the LLNL IM policy for both [initial release and incremental contributions <iclass="fa fa-light fa-lock"></i>](https://dev.llnl.gov/opensource/contributing/). LLNL employees can follow ["one-stop shop" instructions <iclass="fa fa-light fa-lock"></i>](https://dev.llnl.gov/open-source/one-stop-shop/) for releasing software.
104
+
Before content is placed into an LLNL GitHub.com repository, it should be reviewed and released via LLNL's Information Management (IM) process–even if you plan on setting the repository to *Private* instead of *Public*. All information produced by LLNL must follow the guidance set forth by the LLNL IM/RR policy for both [initial release and incremental contributions <iclass="fa fa-light fa-lock"></i>](https://dev.llnl.gov/opensource/contributing/). LLNL employees can follow ["one-stop shop" instructions <iclass="fa fa-light fa-lock"></i>](https://dev.llnl.gov/open-source/one-stop-shop/) for releasing software.
{% include components/accordion.html title="My project is approved for release. Now what? What about docs?" slug='approved' content=accordionContent %}
146
146
147
+
{% capture accordionContent %}
148
+
149
+
Most LLNL repos use the standard GitHub URL of `github.com/llnl/*`. However, you may use the `software.llnl.gov` domain, where you append `/*` to it. Alternatively, you can use GitHub pages to create a custom `*.llnl.gov` URL that redirects to `software.llnl.gov/*`.
150
+
151
+
| --- | ----- | ---- |
152
+
| URL | Setup | Help |
153
+
| --- | ----- | ---- |
154
+
|`github.com/llnl/*`|[Creating a GitHub Pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site)|<github-admin@llnl.gov>|
155
+
|`software.llnl.gov/*`|[Configuring a custom domain for your GitHub Pages site](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site)|<webmaster-comp@llnl.gov>|
156
+
|`*.llnl.gov`|[Managing a custom domain for your GitHub Pages site](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site)|<github-admin@llnl.gov>|
157
+
{:.table .table-striped .table-bordered}
158
+
159
+
**Note:**`software.llnl.gov` uses a reverse proxy and is hosted on LLNL Computing servers, which fetches the content from GitHub behind the scenes. If you would like to use the `software.llnl.gov/*` URL, you do *not* need to check the "Enforce HTTPS" box in your repo's settings (Settings > Pages > Custom Domain > Enforce HTTPS). This checkbox is for sites that point directly to GitHub, not the LLNL Computing servers. The <webmaster-comp@llnl.gov> team manages the DNS and SSL certificate for `software.llnl.gov` only, not for `*.llnl.gov`.
{% include components/accordion.html title='Can I create a custom URL for my repo?' slug='repo-url' content=accordionContent %}
164
+
147
165
{% capture accordionContent %}
148
166
<!-- START: Warning Box -->
149
167
{% capture alertContent %}
150
168
151
169
* Repositories within the LLNL organization are owned and managed by LLNL. Please do not create personal repositories here.
152
-
* All LLNL repos must go through the IM process (see the FAQ [How do I get my repo reviewed and released for GitHub?](https://software.llnl.gov/about/faq/#released)) and display the appropriate open source license and `LLNL-CODE-xxxxxx` release number.
170
+
* All LLNL repos must go through the IM/RR process (see the FAQ [How do I get my repo reviewed and released for GitHub?](https://software.llnl.gov/about/faq/#released)) and display the appropriate open source license and `LLNL-CODE-xxxxxxx` release number.
153
171
* If the repo wasn't developed at LLNL, its license needs to be clearly indicated. See the [LLNL Software Licensing](/about/licenses) page for examples.
154
172
155
173
{% endcapture %}
@@ -184,7 +202,7 @@ Now that your project is on GitHub, make sure users and contributors can find it
184
202
185
203
* See helpful hints on [GitHub's topic help page](https://help.github.com/articles/about-topics/). Add tags relevant to your project's programming language, platforms, and more (e.g., Python, HPC, Linux).
186
204
187
-
2. Let [X/Twitter](https://twitter.com/LLNL_OpenSource) followers know your project is available on GitHub. Feel free to tag the `@LLNL_OpenSource` handle on your own tweet, or submit a request to [open-source@llnl.gov](mailto:open-source@llnl.gov) so we can post on your behalf.
205
+
2. Let [X/Twitter](https://twitter.com/Livermore_Comp) followers know your project is available on GitHub. Feel free to tag the `@Livermore_Comp` handle in your own post, or submit a request to <comp-comms@llnl.gov> to post on your behalf.
188
206
189
207
3. Publicize any outreach activities or major milestones related to your project such as:
190
208
* A paper/poster/presentation is accepted at a conference
@@ -193,7 +211,7 @@ Now that your project is on GitHub, make sure users and contributors can find it
193
211
* You're guest blogging or speaking on a podcast
194
212
{:.mb-3}
195
213
196
-
4. Include a summary of your project with GitHub and documentation links on LLNL's [Computing website](https://computing.llnl.gov/projects). Contact [webmaster-comp@llnl.gov](mailto:webmaster-comp@llnl.gov) for this particular task.
214
+
4. Include a summary of your project with GitHub and documentation links on LLNL's [Computing website](https://computing.llnl.gov/projects). Contact <comp-comms@llnl.gov> for this particular task.
{% include components/accordion.html title='How do I let people know about my new repo?' slug='publicize' content=accordionContent %}
@@ -228,13 +246,13 @@ If you need help re-assigning permissions in your repo, contact [github-admin@ll
228
246
{% include components/accordion.html title='What should I do if my repo is no longer actively developed/maintained?' slug='remove' content=accordionContent %}
229
247
230
248
{% capture accordionContent %}
231
-
The process to transfer organizational ownership is straightforward, but generally discouraged. This should really only be done for projects that are starting to build a "bigger than LLNL" community, and the decision should not be made lightly.
249
+
The process to transfer organizational ownership is straightforward but generally discouraged. This should really only be done for projects that are starting to build a "bigger than LLNL" community, and the decision should not be made lightly.
232
250
233
251
Migrating the repo outside of the LLNL organization requires an organization admin. Contact [github-admin@llnl.gov](mailto:github-admin@llnl.gov) to coordinate the move.
234
252
235
253
**Once the repository has moved to the new organization:**
236
254
237
-
1. Submit a pull request updating the [`input_lists.json` file](https://github.com/LLNL/llnl.github.io/blob/main/_visualize/input_lists.json) to add the new organization/repo's name. This allows for the software catalog to continue including the project even after it moves.
255
+
1. Submit a pull request updating the [`input_lists.json` file](https://github.com/LLNL/llnl.github.io/blob/main/_visualize/input_lists.json) to add the new organization/repo's name. This allows the software catalog to continue including the project even after it moves.
238
256
239
257
2. Retain topic tags (e.g., `math-physics`) to connect it to this website's browsable categories.
240
258
{% endcapture %}
@@ -245,7 +263,7 @@ Migrating the repo outside of the LLNL organization requires an organization adm
245
263
<!-- START: Warning Box -->
246
264
{% capture alertContent %}
247
265
248
-
Even if your collection of repos are housed under another organization but developed on behalf of LLNL, they must go through the IM process (see the FAQ [How do I get my repo reviewed and released for GitHub?](https://software.llnl.gov/about/faq/#released)) and display the appropriate open source license and `LLNL-CODE-xxxxxx` release number.
266
+
Even if your collection of repos are housed under another organization but developed on behalf of LLNL, they must go through the IM/RR process (see the FAQ [How do I get my repo reviewed and released for GitHub?](https://software.llnl.gov/about/faq/#released)) and display the appropriate open source license and `LLNL-CODE-xxxxxxx` release number.
0 commit comments