blob: 76042a5a904d00df930d43b117fb30fba8496d61 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-112407000-2"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() {
dataLayer.push(arguments);
}
gtag('js', new Date());
gtag('config', 'UA-112407000-2');
</script>
<!-- Google Tag Manager -->
<script>
(function (w, d, s, l, i) {
w[l] = w[l] || [];
w[l].push({
'gtm.start': new Date().getTime(),
event: 'gtm.js'
});
var f = d.getElementsByTagName(s)[0],
j = d.createElement(s),
dl = l != 'dataLayer' ? '&l=' + l : '';
j.async = true;
j.src =
'https://www.googletagmanager.com/gtm.js?id=' + i + dl;
f.parentNode.insertBefore(j, f);
})(window, document, 'script', 'dataLayer', 'GTM-KS8HHSF');
</script>
<!-- End Google Tag Manager -->
<head>
<base href="/codewind/" />
<title>Using the project view | Codewind</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Project view">
<meta name="keywords" content="project, view, list, using, coding, run, apply, import, create, edit, log, monitor, project list, project view, page header, project view menu, project view ..."/>
<link rel="icon" type="image/png" sizes="16x16" href="images/favicon-16x16.png">
<link rel="icon" type="image/png" sizes="32x32" href="images/favicon-32x32.png">
<link href="https://fonts.googleapis.com/css?family=IBM+Plex+Sans:300,400,600&display=swap" rel="stylesheet">
<!-- Bootstrap CSS CDN -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css"
integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" />
<link rel="stylesheet" href="css/styles.css">
<link rel="stylesheet" href="css/docs.css">
</head>
<body data-spy="scroll" data-target="#toc">
<!-- Google Tag Manager (noscript) -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KS8HHSF"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager (noscript) -->
<div class="main">
<!-- Bootstrap NavBar -->
<nav class="navbar navbar-expand-lg navbar-light cw-banner fixed-top">
<button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse"
data-target="#navbarNavDropdown" aria-controls="navbarNavDropdown" aria-expanded="false"
aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<a class="navbar-brand" href="">
<img src="images/header-logo.svg" class="cw-header-logo" alt="">
</a>
<div class="collapse navbar-collapse justify-content-end cw-navbar-padding" id="navbarNavDropdown">
<ul class="navbar-nav cw-navbar-nav">
<li class="nav-item cw-navbar-item cw-header-link">
<a class="nav-link cw-nav-link" href="docindex.html">Docs</a>
</li>
<!-- li class="nav-item cw-navbar-item" id="download-li">
<button onClick="window.location.href='https://microclimate.dev/download/codewind';" type="button" class="btn cw-download-button">Download</button>
<a href="https://microclimate.dev/download/codewind" class="nav-link cw-nav-link cw-download-link" href="#">Download</a>
</li> -->
<li class="nav-item cw-navbar-item" id="github-stars-button">
<!-- Place this tag where you want the button to render. -->
<a class="github-button" href="https://github.com/eclipse/codewind" data-size="large"
data-show-count="true" aria-label="Star eclipse/codewind on GitHub">Star</a>
</li>
<!-- Smaller devices menu END -->
</ul>
</div>
</nav>
<!-- NavBar END -->
<!-- Bootstrap row -->
<div class="row" id="body-row">
<!-- Sidebar -->
<div id="sidebar-container" class="bg-light">
<!-- Bootstrap List Group -->
<ul class="list-group sticky-top bg-light cw-sticky-offset">
<!-- Separator with title -->
<li class="list-group-item cw-sidebar-separator-title cw-text-gray d-flex bg-light align-items-center menu-collapsed">
<small class="badge badge-success cw-margin-auto">DOCUMENTS</small>
</li>
<!-- /END Separator -->
<!-- Hard coded TOC -->
<a href="#install_on_cloud" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Installing and Using Codewind on Cloud</span>
<span class="submenu-icon ml-auto"></span>
</div>
</a>
<div id="install_on_cloud" class="cw-sidebar-div cw-sidebar-submenu collapse" style="">
<a href="installoncloud.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Installing and Using Codewind on Kubernetes</span>
</div>
</a>
<a href="supportingmultipleusers.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Support for multiple users</span>
</div>
</a>
<a href="viewkibanalogs.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Viewing logs using Kibana in IBM Cloud Private</span>
</div>
</a>
</div>
<a href="installlocally.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Installing Codewind locally</span>
</div>
</a>
<a href="#codewind_for_eclipse" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Codewind for Eclipse</span>
<span class="submenu-icon ml-auto"></span>
</div>
</a>
<div id="codewind_for_eclipse" class="cw-sidebar-div cw-sidebar-submenu collapse" style="">
<a href="mdteclipseoverview.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Overview</span>
</div>
</a>
<a href="mdteclipsegettingstarted.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Installation and Getting Started</span>
</div>
</a>
<a href="mdteclipsemanagingprojects.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Managing Codewind projects</span>
</div>
</a>
<a href="mdteclipsebuildproject.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Building Codewind projects</span>
</div>
</a>
<a href="mdteclipsedebugproject.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Debugging Codewind projects</span>
</div>
</a>
<a href="mdteclipsetroubleshooting.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Troubleshooting</span>
</div>
</a>
<a href="mdteclipseuninstall.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Uninstalling</span>
</div>
</a>
</div>
<a href="#codewind_for_vscode" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Codewind for VS Code</span>
<span class="submenu-icon ml-auto"></span>
</div>
</a>
<div id="codewind_for_vscode" class="cw-sidebar-div cw-sidebar-submenu collapse" style="">
<a href="mdt-vsc-overview.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Overview</span>
</div>
</a>
<a href="mdt-vsc-getting-started.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Getting started</span>
</div>
</a>
<a href="mdt-vsc-tutorial.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Tutorial</span>
</div>
</a>
<a href="mdt-vsc-commands-overview.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Commands overview</span>
</div>
</a>
<a href="mdt-vsc-commands-project.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Project commands</span>
</div>
</a>
<a href="mdt-vsc-commands-restart-and-debug.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Restart and debug commands</span>
</div>
</a>
<a href="mdt-vsc-troubleshooting.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Troubleshooting</span>
</div>
</a>
<a href="mdt-vsc-uninstall.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Uninstalling</span>
</div>
</a>
</div>
<a href="#configuring_codewind" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Configuring Codewind</span>
<span class="submenu-icon ml-auto"></span>
</div>
</a>
<div id="configuring_codewind" class="cw-sidebar-div cw-sidebar-submenu collapse" style="">
<a href="usingadifferenttemplate"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Using a template repository of your own</span>
</div>
</a>
</div>
<a href="guide_performance.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Guide: Monitoring applications with the performance dashboard</span>
</div>
</a>
<a href="uninstall.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Uninstalling Codewind</span>
</div>
</a>
<a href="troubleshooting.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Troubleshooting</span>
</div>
</a>
<a href="limitations.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Limitations</span>
</div>
</a>
<!-- END hard coded TOC -->
<!-- Separator without title -->
<li class="list-group-item cw-sidebar-separator-title bg-light cw-text-gray d-flex align-items-center menu-collapsed">
<small class="badge badge-success cw-margin-auto">HELPFUL
LINKS</small>
</li>
<!-- /END Separator -->
<a href="https://projects.eclipse.org/proposals/eclipse-codewind" class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Eclipse Codewind project page</span>
</div>
</a>
<!-- Logo -->
<li class="list-group-item cw-logo-separator bg-light d-flex justify-content-center">
<img src="images/header-logo.svg">
</li>
</ul>
<!-- List Group END-->
</div>
<!-- sidebar-container END -->
<!-- MAIN -->
<div id="content-container" class="py-5 px-5">
<div role="main"><h1 id="using-the-project-view">Using the project view</h1>
<h2 id="project-list">Project list</h2>
<p>After you create or import a project into Microclimate, you can view, administer, and modify it. In your Microclimate workspace, click the <strong>Projects</strong> tab to view the list of all of your projects and their statuses.</p>
<p>To view details about a project, click the project name. You can also click the shortcut menu alongside a project name for the same options. To delete a project, click the <code class="highlighter-rouge">Delete project</code> option on the shortcut menu.</p>
<h2 id="project-view">Project view</h2>
<p>The project view page has three parts:</p>
<ul>
<li><a href="#page-header">Page header</a></li>
<li><a href="#project-view-menu">Menu</a></li>
<li><a href="#project-view-main-workspace">Main workspace</a></li>
</ul>
<h3 id="page-header">Page header</h3>
<p>The page header contains the following information:</p>
<ul>
<li>Project name</li>
<li>Project status</li>
<li>Build status</li>
<li>A <code class="highlighter-rouge">Build</code> button to manually rebuild your projects</li>
</ul>
<h3 id="project-view-menu">Project view menu</h3>
<p>At the side of the page is a menu:</p>
<p><img src="dist/images/projectmenu.png" alt="Image of menu" /></p>
<p>From this menu, you have seven options:</p>
<ol>
<li>
<p><strong>Overview</strong> Provides you with project information including language, location of you project, status, and whether the project is set to automatically build on modification.</p>
</li>
<li>
<p><strong>Edit code</strong> After creating your project, Microclimate has already built your project and started it. Use the Theia editor to modify your code, and to redeploy it.</p>
</li>
<li><strong>Build logs</strong> Click this tab to view the Microclimate project build logs.
<ul>
<li>On the <strong>Build logs</strong> page, the <strong>Log File</strong> drop-down menu lists individual build logs. If a log file changed, an <strong>Updated</strong> icon appears next to the <strong>Log File</strong> menu. An asterisk appears next to the name of each changed log file in the list.</li>
<li>After you select any of the changed log files, the asterisk disappears from the log file entry in the menu. After you select all of the changed log files, the icon disappears from the <strong>Log File</strong> menu.</li>
</ul>
</li>
<li>
<p><strong>Open app</strong> Supply the context root and then open your application.</p>
</li>
<li>
<p><strong>App logs</strong> Log files for your application.</p>
</li>
<li>
<p><strong>App monitor</strong> Use this tab to monitor your application.</p>
</li>
<li><strong>Pipeline</strong> Use a pipeline to automatically detect changes in your application, and to rebuild and redeploy it. For more information, see <a href="./usingapipeline">Using a pipeline</a>.</li>
</ol>
<h3 id="project-view-main-workspace">Project view main workspace</h3>
<p>The main workspace provides a summary of your project including language, location, and status.</p>
<p>By default, your project automatically builds when you save your project files. Use the <code class="highlighter-rouge">Auto build</code> switch located on this page to control automatic building of your project.</p>
<p>Use the <code class="highlighter-rouge">Disable project</code> button to disable project development. For more information, see <a href="./disabledevelopmentonprojects">Disable development on specific projects</a>.</p>
<h3 id="viewing-log-files">Viewing log files</h3>
<p>You can view multiple log files in <strong>Build logs</strong> and <strong>Apps logs</strong> by selecting a log from the <strong>Log File</strong> dropdown menu.</p>
<p>When one or more log files have changed, an <code class="highlighter-rouge">Updated</code> notice is displayed. The changed logs are marked with <code class="highlighter-rouge">*</code>.</p>
<p>If there are no log files, the dropdown menu will be empty.</p>
<p><img src="dist/images/viewingmultiplelogfiles.png" alt="Image of log files" /></p>
<h2 id="need-help">Need help?</h2>
<p>If you encounter problems with using the project view, check the <a href="troubleshooting#using-the-project-view">Troubleshooting page</a>.</p>
</div>
</div>
</div>
<!-- Main Col END -->
<!-- footer row -->
<footer>
<div class="row" id="footer-div">
<div class="col-lg-3 col-md-3 footer-col text-center">
<div>
<div>
<a href="https://twitter.com/EclipseCodewind"><img src="images/twitter-logo.svg" class="cw-logo" /></a>
</div>
<div>@EclipseCodewind</div>
</div>
</div>
<div class="col-lg-3 col-md-3 footer-col text-center">
<div>
<div>
<a href="https://github.com/eclipse/codewind"><img src="images/github-logo.svg"
class="cw-logo" /></a>
</div>
<div>@Codewind</div>
</div>
</div>
<div class="col-lg-3 col-md-3 footer-col text-center">
<div>
<div>
<a href="mailto:codewind-dev@eclipse.org"><img src="images/email-icon.svg" class="cw-logo" /></a>
</div>
<div>@Codewind</div>
</div>
</div>
<div class="col-lg-3 col-md-3 footer-col text-center">
<div class="cw-logo-mm" >
<div class="cw-logo-mm" >
<a href="mailto:codewind-dev@eclipse.org"><img src="images/mattermost-logo.png" class="cw-logo-mm" /></a>
</div>
</div>
</div>
</div>
</footer>
<!-- footer row END --> <!-- Jquery -->
<script
src="https://code.jquery.com/jquery-3.4.1.min.js"
integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo="
crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js"
integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous">
</script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js"
integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous">
</script>
<!-- Font Awesome JS -->
<script defer src="https://use.fontawesome.com/releases/v5.0.13/js/solid.js"
integrity="sha384-tzzSw1/Vo+0N5UhStP3bvwWPq+uvzCMfrN1fEFe+xBmv1C/AtVX5K0uZtmcHitFZ" crossorigin="anonymous">
</script>
<script defer src="https://use.fontawesome.com/releases/v5.0.13/js/fontawesome.js"
integrity="sha384-6OIrr52G08NpOFSZdxxz1xdNSndlD4vdcf/q2myIUVO0VsqaGHJsB0RaBE01VTOY" crossorigin="anonymous">
</script>
<!-- Place this tag in your head or just before your close body tag. -->
<script async defer src="https://buttons.github.io/buttons.js"></script>
<script src="js/jquery.matchHeight-min.js"></script>
<script src="js/index.js"></script>
<script src="js/docs.js"></script>
</div>
</body>
</html>